Add publint to CI

[alexeyr-ci]

Summary

Add additional checks to CI with publint.

Pull Request checklist

• [ ] Add/update test to cover these changes
• [ ] Update documentation
• [ ] Update CHANGELOG file

---

This change is 

Summary by CodeRabbit

• Chores
  • Updated the packaging and linting process to validate a pre-packaged artifact, ensuring a more reliable validation and deployment flow.
  • Enhanced module configuration and dependency management for improved consistency.
  • Refined automation scripts handling package dependencies to ensure correct dependency adjustments during the build process.

[coderabbitai]

Walkthrough

This PR updates the linting workflow by replacing and adding steps in the .github/workflows/lint-js-and-ruby.yml file. It also adds a "type": "commonjs" property and a "publint": "^0.3.8" dependency in package.json. Additionally, the script/convert file has been modified to adjust how package.json dependencies are managed, specifically by retaining the "knip" package and removing "publint". These changes shift the process to package-based linting and update dependency handling.

Changes

File	Summary of Changes
.github/workflows/lint-js-and-ruby.yml	Replaced the former "Lint package publishing" step with a new sequence that includes "Pack for attw and publint", "Lint package types", and an updated "Lint package publishing" step using packaged file commands.
package.json	Added "type": "commonjs" and included "publint": "^0.3.8" in the devDependencies to support the updated linting workflow.
script/convert	Adjusted gsub_file_content calls: commented out removal of "knip" and added removal of "publint", modifying how package dependencies are managed.

Sequence Diagram(s)

sequenceDiagram
    participant Repo as Repository Workflow
    participant Yarn as Yarn CLI
    participant Attw as Type Linter
    participant Publint as Publishing Linter

    Repo->>Yarn: Execute "yarn pack -f react-on-rails.tgz"
    Yarn-->>Repo: Packaged file generated
    Repo->>Yarn: Run "yarn run attw react-on-rails.tgz --profile node16 --ignore-rules cjs-only-exports-default"
    Yarn->>Attw: Perform type linting on package
    Attw-->>Repo: Return lint results
    Repo->>Yarn: Run "yarn run publint --strict react-on-rails.tgz"
    Yarn->>Publint: Perform publishing linting on package
    Publint-->>Repo: Return lint results

Loading

Possibly related PRs

• Check published types in CI #1702: Contains similar workflow modifications, particularly around the "Lint package publishing" step.

Suggested reviewers

• AbanoubGhadban
• Judahmeek

Poem

I'm a little rabbit, hopping with code delight,
Through workflows and packages in the digital night.
Yarn commands tap-dance like carrots in a row,
Linting steps align, making our package glow.
In this garden of updates, may our changes forever grow!
🥕🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aefc545 and f43f7de.

⛔ Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (3)

• .github/workflows/lint-js-and-ruby.yml (1 hunks)
• package.json (2 hunks)
• script/convert (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: dummy-app-integration-tests (newest)
• GitHub Check: dummy-app-integration-tests (oldest)
• GitHub Check: rspec-package-tests (newest)
• GitHub Check: rspec-package-tests (oldest)
• GitHub Check: build

🔇 Additional comments (6)

package.json (2)

6-6: Good addition: Setting CommonJS module type.

The addition of "type": "commonjs" explicitly specifies that this package uses the CommonJS module system, which helps ensure consistent module resolution across different environments and tools.

---

53-53: Good addition: Publint dependency for package validation.

Adding publint as a devDependency is appropriate since it will be used in the CI workflow to lint the package for publishing issues. The version ^0.3.8 follows good semver practice by allowing compatible updates.

script/convert (1)

22-23:

❓ Verification inconclusive

Clarify the purpose of removing publint in the conversion script.

There appears to be a contradiction - you're adding publint in package.json but removing it here in the conversion script. This might lead to inconsistent behavior depending on when and where this script is run.

---

🏁 Script executed:

#!/bin/bash
# Check where and how the script/convert is being used in the CI process

echo "Checking for references to script/convert in GitHub workflows:"
grep -r "script/convert" .github/workflows/

echo "Checking if there are any documented usages or explanations:"
grep -r -A 5 -B 5 "script/convert" README.md docs/

Length of output: 656

---

Action Required: Clarify Dependency Handling for “publint” in the Conversion Script

In the conversion script (script/convert, lines 22–23), we remove "publint" from ../package.json with the following calls:

gsub_file_content("../package.json", /"knip": "[^"]*",/, "")
gsub_file_content("../package.json", /"publint": "[^"]*",/, "")

However, there is an apparent contradiction since elsewhere (or in the expected configuration) publint is being added to package.json. Given that this conversion script is actively used in several GitHub workflow files (as seen in the CI pipeline references), this discrepancy might lead to inconsistent behavior depending on when and where the script is run.

Please clarify whether:

• The removal of publint is intended as part of a deprecation or migration strategy, or
• The logic for adding and removing the dependency should be rebalanced to ensure consistency across the codebase.

A clear explanation and, if necessary, corresponding adjustments in either the conversion script or the package configuration will help avoid unintended side effects in the CI process.

.github/workflows/lint-js-and-ruby.yml (3)

90-91: Good preparation step for linting tools.

Creating a package archive first is the correct approach since tools like publint and attw are designed to analyze packaged artifacts rather than source files.

---

92-96: Good addition: Package types verification.

Adding the attw check ensures the package's TypeScript types are correctly exported and accessible to consumers. The ignore rule for cjs-only-exports-default appears to be a known limitation that will be addressed in a future version.

---

97-98: Good implementation of publint validation.

Using publint with the --strict flag ensures rigorous validation of the package's publishing configuration, which aligns perfectly with the PR's objective of improving CI checks.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.