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

Respect typesVersion field #42

Open
bluwy opened this issue May 18, 2023 · 4 comments
Open

Respect typesVersion field #42

bluwy opened this issue May 18, 2023 · 4 comments
Labels
bug Something isn't working

Comments

@bluwy
Copy link
Owner

bluwy commented May 18, 2023

See faker-js/faker#1966

typesVersion remaps the types path and should be taken into account when checking if the file exists.

@bluwy bluwy added the bug Something isn't working label May 18, 2023
@bluwy
Copy link
Owner Author

bluwy commented May 20, 2023

bluwy added a commit that referenced this issue Jun 29, 2023
temporary fix for #42 for now
@bluwy
Copy link
Owner Author

bluwy commented Jun 29, 2023

Published v0.1.13 with a patch to ignore the error for now if "typesVersions" exist. Might return in making the resolution work again in the future, so leaving this open.

tnez pushed a commit to tnez/actions that referenced this issue Jun 30, 2023
[![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)) | [`0.1.12` ->
`0.1.13`](https://renovatebot.com/diffs/npm/publint/0.1.12/0.1.13) |
[![age](https://badges.renovateapi.com/packages/npm/publint/0.1.13/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/publint/0.1.13/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/publint/0.1.13/compatibility-slim/0.1.12)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/publint/0.1.13/confidence-slim/0.1.12)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

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

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

##### Bug fixes

- Fix `"types"` condition-is-first check when there's preceding
conditions that has it's `"types"` condition too. This is common for
dual ESM-CJS packages where `"types"` are located within `"require"` and
`"import"` conditions.
([bluwy/publint#47)
- Temporarily skip `"types"` condition check when `"typesVersions"` key
exist. The `"typesVersions"` key requires a complex resolution algorithm
that is harder to implement, so a quick patch is applied to remove the
false errors for now.
([bluwy/publint#42)

**Full Changelog**:
bluwy/publint@v0.1.12...v0.1.13

</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:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNDQuMiIsInVwZGF0ZWRJblZlciI6IjM1LjE0NC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
kodiakhq bot pushed a commit to ascorbic/unpic-img that referenced this issue Sep 3, 2023
[![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)) | [`^0.1.12` -> `^0.2.0`](https://renovatebot.com/diffs/npm/publint/0.1.12/0.2.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/publint/0.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/publint/0.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/publint/0.1.12/0.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/publint/0.1.12/0.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

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

### [`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 ([bluwy/publint#60)
-   Check packed files when globbing exports locally ([bluwy/publint#61)
-   Improve `"browser"` field suggestion for using `"imports"` and `"exports"` fields instead ([bluwy/publint#59)

##### Bug fixes

-   Lower deprecated trailing slash glob syntax as `suggestion` instead of a `warning` when it's used for backwards compatibility only ([bluwy/publint#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 [bluwy/publint#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 ([bluwy/publint#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 [bluwy/publint#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. ([bluwy/publint#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. ([bluwy/publint#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). ([bluwy/publint#46)

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

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

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

##### Bug fixes

-   Don't enforce the `module` condition to precede `import` per se. It is now ensured to precede `require` only as otherwise the condition isn't effective ([bluwy/publint#50)

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

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

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

##### Bug fixes

-   Fix "precede" typo

**Full Changelog**: bluwy/publint@v0.1.14...v0.1.15

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

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

##### Features

-   Check that the `"module"` condition precedes the `"import"` and `"require"` in exports conditions ([bluwy/publint#49)

##### Bug fixes

-   Skip linting flow files
-   Improve exports array logging format

##### Site

-   Fix `isPathDir` check

##### New Contributors

-   [@&#8203;nvie](https://togithub.com/nvie) made their first contribution in [bluwy/publint#49

**Full Changelog**: bluwy/publint@v0.1.13...v0.1.14

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

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

##### Bug fixes

-   Fix `"types"` condition-is-first check when there's preceding conditions that has it's `"types"` condition too. This is common for dual ESM-CJS packages where `"types"` are located within `"require"` and `"import"` conditions. ([bluwy/publint#47)
-   Temporarily skip `"types"` condition check when `"typesVersions"` key exist. The `"typesVersions"` key requires a complex resolution algorithm that is harder to implement, so a quick patch is applied to remove the false errors for now. ([bluwy/publint#42)

**Full Changelog**: bluwy/publint@v0.1.12...v0.1.13

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 9pm on sunday" (UTC), 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/ascorbic/unpic-img).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi43OC44IiwidXBkYXRlZEluVmVyIjoiMzYuNzguOCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
@phryneas
Copy link

phryneas commented Apr 2, 2024

Just wanted to jump in here and also give a +1 on this - we'd be very interested to see the FILE_DOES_NOT_EXIST check applied to the types and typesVersions field.

Right now we have to keep our own hand-written tool on top of publint, and would be very happy if we could drop that :)

(Adding publint to the repo over in apollographql/apollo-client-nextjs#264 in case you're tracking the libraries using it 😄 )

@bluwy
Copy link
Owner Author

bluwy commented Apr 4, 2024

Awesome! IIRC the resolver for typesVersion was really complex and not comprehensively documented, and it was hard to portray an error for multiple specified TypeScript versions. But otherwise if anyone (or me in the future) would like to contribute this fix, that would be great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants