Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency publint to ^0.2.0 #48

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 26, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
publint (source) ^0.1.9 -> ^0.2.0 age adoption passing confidence

Release Notes

bluwy/publint (publint)

v0.2.12

Compare Source

Features
Bug fixes
Site

Full Changelog: bluwy/publint@v0.2.11...v0.2.12

v0.2.11

Compare Source

Features
New Contributors

Full Changelog: bluwy/publint@v0.2.10...v0.2.11

v0.2.10

Compare Source

Features
  • Adds a new rule that validates the "repository" field (https://github.com/bluwy/publint/pull/106)
    • If "repository" is a string, it must be one of the supported shorthand strings from the docs.
    • If "repository" is an object with "type": "git", the "url" must be a valid git URL and can be parsed by npm.
    • The git:// protocol for GitHub repos should not be used due security concerns.
    • GitHub or GitLab links should be prefixed with git+ and postfixed with .git. (This is also warned by npm when publishing a package).

New Contributors

Full Changelog: bluwy/publint@v0.2.9...v0.2.10

v0.2.9

Compare Source

Bug fixes
New Contributors

Full Changelog: bluwy/publint@v0.2.8...v0.2.9

v0.2.8

Compare Source

Bug fixes

Full Changelog: bluwy/publint@v0.2.7...v0.2.8

v0.2.7

Compare Source

Features
  • If the library exports from both "main"/"module" and "exports" fields, but the "exports" field doesn't export the root entrypoint, warn about the inconsistency. When "exports" is defined, it takes the highest priority, so all the library's entrypoint (root and deep) needs to be specified here. (https://github.com/bluwy/publint/issues/88)
  • Suggest using the "type" field. In Node.js v20.10.0, it introduces a new --experimental-default-type flag to flip the default module system from "CJS-as-default" to "ESM-as-default". It's recommended for libraries to specify the "type" field explicitly to prevent CJS files from being incorrectly interpreted as ESM. This suggestion helps push towards a better ESM experience in the future. (https://github.com/bluwy/publint/issues/83)

Full Changelog: bluwy/publint@v0.2.6...v0.2.7

v0.2.6

Compare Source

Features
Site
New Contributors

Full Changelog: bluwy/publint@v0.2.5...v0.2.6

v0.2.5

Compare Source

Bug fixes

Full Changelog: bluwy/publint@v0.2.4...v0.2.5

v0.2.4

Compare Source

Bug fixes
  • Check for packed files locally before providing the "files" suggestion. An incorrect suggestion was given when you're using .npmignore or .gitignore to limit publishing certain files.
Site
  • Fix rules page mobile responsiveness

Full Changelog: bluwy/publint@v0.2.3...v0.2.4

v0.2.3

Compare Source

Features
  • Error if package.json has fields with invalid string, boolean, object, etc type (https://github.com/bluwy/publint/issues/73)

  • Suggest using the "files" field if detected test or config files are published (https://github.com/bluwy/publint/issues/77)

  • Warn on "exports" and "browser" object conflict for browser-ish environments (https://github.com/bluwy/publint/issues/58)

    For example, given this setup:

    {
      "browser": {
        "./lib.server.js": "./lib.browser.js"
      },
      "exports": {
        ".": {
          "worker": "./lib.server.js",
          "browser": "./lib.browser.js",
          "default": "./lib.server.js"
        }
      }
    }

    When matching the "worker" condition, it will resolve to "./lib.server.js" which is intended to work in a worker environment. However, the "browser" field also has a matching mapping for "./lib.server.js", causing the final resolved path to be "./lib.browser.js". This is usually not intended and causes the wrong file to be loaded.

  • Error on invalid JSX extensions, such as .cjsx, .mjsx, .ctsx, and .mtsx (https://github.com/bluwy/publint/issues/76)

    These extensions are usually mistaken as ESM and CJS variants of JSX, which is not valid. Instead they should be written in ESM with the .jsx extension instead.

Bug fixes
Site

Full Changelog: bluwy/publint@v0.2.2...v0.2.3

v0.2.2

Compare Source

Features
Bug fixes
  • Lower deprecated trailing slash glob syntax as suggestion instead of a warning when it's used for backwards compatibility only (https://github.com/bluwy/publint/issues/62)
  • Suppress invalid globbed file format if has correct adjacent file
  • Fix extension replacement in messages
  • Improve invalid types format message and docs
Site
  • Fix invalid package name not found message
  • Highlight code blocks in rules page
New Contributors

Full Changelog: bluwy/publint@v0.2.1...v0.2.2

v0.2.1

Compare Source

Bug fixes
  • Fix "types" condition check with "exports" array format
  • Disable packed files search when a vfs is passed
  • Fix "browser" field file existence extensions check
  • Fix file existence check with trailing slash
Site
  • Site-wide design touch-up
  • New "Popular packages" section
  • New package version select switcher (https://github.com/bluwy/publint/issues/56)
  • New navigation header design
  • Update bottom documentation for clarity
  • Improve repo URL parsing
New Contributors

Full Changelog: bluwy/publint@v0.2.0...v0.2.1

v0.2.0

Compare Source

Breaking changes

Note: If you're using publint from the CLI, these breaking changes should not affect you.

  • publint() now returns an object with messages instead of the messages array directly. This makes way for future APIs where publint will return more information than just messages.

    - const messages = await publint()
    + const { messages } = await publint()
  • Rename printMessage API to formatMessage to better reflect it's intent. (https://github.com/bluwy/publint/issues/43)

    - import { printMessage } from "publint/utils"
    + import { formatMessage } from "publint/utils"
    
    const { messages } = await publint()
    
    for (const message of messages) {
    - console.log(printMessage(message))
    + console.log(formatMessage(message))
    }
  • Remove filePath arg for the FILE_DOES_NOT_EXIST message.

    import type { Message } from "publint"
    import { getPkgPathValue } from "publint/utils"
    
    function messageToString(message: Message, pkg: Record<string, any>) {
      switch (message.code) {
        case "FILE_DOES_NOT_EXIST":
    -     return `The file "${message.args.filePath}" does not exist.`
    +     return `The file "${getPkgPathValue(pkg, message.path)}" does not exist.`
      }
    }
  • Remove the import condition for the publint package. This provides a better error message if you call require("publint").

Features
  • Improve warnings when the exported "types" condition has an invalid format in ESM or CJS. This ensures your library's types will work in both environments when dual publishing. (https://github.com/bluwy/publint/issues/46)

    It affects packages commonly packaged like:

    {
      "exports": {
        ".": {
          "types": "./index.d.ts", <-- only works in CJS
          "import": "./index.mjs",
          "require": "./index.js",
        }
      }
    }

    For more information, visit the rules documentation. This feature is inspired by https://arethetypeswrong.github.io.

Bug fixes

Full Changelog: bluwy/publint@v0.1.16...v0.2.0


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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 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.

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.87%. Comparing base (51ef798) to head (58ae634).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #48   +/-   ##
=======================================
  Coverage   87.87%   87.87%           
=======================================
  Files          13       13           
  Lines         404      404           
  Branches       52       52           
=======================================
  Hits          355      355           
  Misses         49       49           

@DanielRivers DanielRivers merged commit 41e28e1 into main Nov 26, 2024
4 checks passed
@renovate renovate bot deleted the renovate/publint-0.x branch November 26, 2024 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant