Skip to content

Commit

Permalink
chore(deps): update dependency publint to v0.2.7 (#56)
Browse files Browse the repository at this point in the history
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [publint](https://publint.dev)
([source](https://togithub.com/bluwy/publint/tree/HEAD/pkg)) | [`0.1.16`
-> `0.2.7`](https://renovatebot.com/diffs/npm/publint/0.1.16/0.2.7) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/publint/0.2.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/publint/0.2.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/publint/0.1.16/0.2.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/publint/0.1.16/0.2.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>bluwy/publint (publint)</summary>

### [`v0.2.7`](https://togithub.com/bluwy/publint/releases/tag/v0.2.7)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.2.6...v0.2.7)

##### 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](https://togithub.com/bluwy/publint/issues/88))
- Suggest using the `"type"` field. In [Node.js
v20.10.0](https://nodejs.org/en/blog/release/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](https://togithub.com/bluwy/publint/issues/83))

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

### [`v0.2.6`](https://togithub.com/bluwy/publint/releases/tag/v0.2.6)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.2.5...v0.2.6)

##### Features

- Warn if the deprecated `jsnext:main` or `jsnext` fields are used by
[@&#8203;sapphi-red](https://togithub.com/sapphi-red)
([https://github.com/bluwy/publint/pull/85](https://togithub.com/bluwy/publint/pull/85))

##### Site

- Fix command on site by [@&#8203;wooorm](https://togithub.com/wooorm)
([https://github.com/bluwy/publint/pull/82](https://togithub.com/bluwy/publint/pull/82))

##### New Contributors

- [@&#8203;wooorm](https://togithub.com/wooorm) made their first
contribution in
[https://github.com/bluwy/publint/pull/82](https://togithub.com/bluwy/publint/pull/82)

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

### [`v0.2.5`](https://togithub.com/bluwy/publint/releases/tag/v0.2.5)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.2.4...v0.2.5)

##### Bug fixes

- Fix missing published files check when resolving a path with fallback
extensions
([https://github.com/bluwy/publint/issues/79](https://togithub.com/bluwy/publint/issues/79))

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

### [`v0.2.4`](https://togithub.com/bluwy/publint/releases/tag/v0.2.4)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.2.3...v0.2.4)

##### 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`](https://togithub.com/bluwy/publint/releases/tag/v0.2.3)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.2.2...v0.2.3)

##### Features

- Error if `package.json` has fields with invalid string, boolean,
object, etc type
([https://github.com/bluwy/publint/issues/73](https://togithub.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](https://togithub.com/bluwy/publint/issues/77))

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

    For example, given this setup:

    ```json
    {
      "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](https://togithub.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

-   Skip file format checks only for globbed files
- Fix `"main"` field with ESM content detection
([https://github.com/bluwy/publint/issues/75](https://togithub.com/bluwy/publint/issues/75))

##### Site

- Add sidebar menu to rules page by
[@&#8203;btea](https://togithub.com/btea)
([https://github.com/bluwy/publint/pull/65](https://togithub.com/bluwy/publint/pull/65))
- Quickly scroll to the prompt information location by
[@&#8203;btea](https://togithub.com/btea)
([https://github.com/bluwy/publint/pull/68](https://togithub.com/bluwy/publint/pull/68))
- Fix version switch title not updated by
[@&#8203;btea](https://togithub.com/btea)
([https://github.com/bluwy/publint/pull/72](https://togithub.com/bluwy/publint/pull/72))
-   Improve documentation for `"types"` format
-   Fix message border styles
-   Fix docs list missing dot

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

### [`v0.2.2`](https://togithub.com/bluwy/publint/releases/tag/v0.2.2)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.2.1...v0.2.2)

##### Features

- Lint `"typings"` field file existence
([https://github.com/bluwy/publint/pull/60](https://togithub.com/bluwy/publint/pull/60))
- Check packed files when globbing exports locally
([https://github.com/bluwy/publint/issues/61](https://togithub.com/bluwy/publint/issues/61))
- Improve `"browser"` field suggestion for using `"imports"` and
`"exports"` fields instead
([https://github.com/bluwy/publint/pull/59](https://togithub.com/bluwy/publint/pull/59))

##### 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](https://togithub.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

- [@&#8203;btea](https://togithub.com/btea) made their first
contribution in
[https://github.com/bluwy/publint/pull/64](https://togithub.com/bluwy/publint/pull/64)

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

### [`v0.2.1`](https://togithub.com/bluwy/publint/releases/tag/v0.2.1)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.2.0...v0.2.1)

##### 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](https://togithub.com/bluwy/publint/issues/56))
-   New navigation header design
-   Update bottom documentation for clarity
-   Improve repo URL parsing

##### New Contributors

- [@&#8203;lachlancollins](https://togithub.com/lachlancollins) made
their first contribution in
[https://github.com/bluwy/publint/pull/53](https://togithub.com/bluwy/publint/pull/53)

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

### [`v0.2.0`](https://togithub.com/bluwy/publint/releases/tag/v0.2.0)

[Compare
Source](https://togithub.com/bluwy/publint/compare/v0.1.16...v0.2.0)

##### 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`.

    ```diff
    - 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](https://togithub.com/bluwy/publint/issues/43))

    ```diff
    - 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.

    ```diff
    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](https://togithub.com/bluwy/publint/issues/46))

    It affects packages commonly packaged like:

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

For more information, visit the [rules
documentation](https://publint.dev/rules#export_types_invalid_format).
This feature is inspired by https://arethetypeswrong.github.io.

##### Bug fixes

- Suppress warnings when exported JS files using the `"exports"` field
have adjacent `.d.ts` files and no `"types"` condition. This follows
TypeScript's resolution algorithm. For more information, visit the
[rules documentation](https://publint.dev/rules#types_not_exported).
([https://github.com/bluwy/publint/issues/46](https://togithub.com/bluwy/publint/issues/46))

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

</details>

---

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

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/tnez/actions).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMS4wIiwidXBkYXRlZEluVmVyIjoiMzcuMTAzLjEiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
  • Loading branch information
renovate[bot] authored Dec 30, 2023
1 parent 8d1e5e7 commit 2650da4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"jest-mock-extended": "3.0.4",
"lint-staged": "13.2.3",
"prettier": "3.1.1",
"publint": "0.1.16",
"publint": "0.2.7",
"ts-jest": "29.1.1",
"tsup": "7.2.0",
"typescript": "5.1.6",
Expand Down
8 changes: 4 additions & 4 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2650da4

Please sign in to comment.