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.

Sign up for GitHub

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

Jump to bottom

🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions #1984

Closed
rivy opened this issue Nov 11, 2021 · 8 comments
Closed

🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions #1984

rivy opened this issue Nov 11, 2021 · 8 comments
Labels
enhancement new issue

Comments

@rivy
Copy link
Contributor

rivy commented Nov 11, 2021

Is your feature request related to a problem? Please describe.

Yes, tracking down a weird cspell CI failure (Configuration Error: Failed to find config file at: "'.vscode/cSpell.json'" for a file that obviously existed) lead to the realization that cspell deprecated NodeJS v10 after a couple of hours banging on the CI hosts. It would have been much quicker and easier to fix if cspell had simply emitted a warning (or error) that the use on a current JS version < vM.m was no longer supported.

Describe the solution you'd like

Please emit a warning or an error to the user that the Node JS version is not supported whenever the script is run on a outdated/non-supported version.
rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 11, 2021
@rivy
fix/CICD ~ repair broken cspell by pinning it to version v4.2.8
bd11d4f 
## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
@nschonni
Copy link
Collaborator

cspell/packages/cspell/package.json

Lines 87 to 89 in 020e931

"engines": {
"node": ">=12.13.0"
},
already declares the required version that NPM should warn about when installing

rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 11, 2021
@rivy
fix/CICD ~ repair broken cspell by pinning it to version v4.2.8
d71c5f7 
## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
@rivy
Copy link
Contributor Author

rivy commented Nov 11, 2021

Agreed, the package does declare the requirement, and so, this is not a bug report.

But npm tends to vomit out multiple warnings when installing packages and so, especially for automation, it generally must be ignored.

Hence, this feature request that would have cspell itself, when used on an unsupported platform version, emit a warning or error at the point of use. This would be more dev/user friendly and quite helpful to track down the root of an issue when cspell starts failing.

Thanks for the attention and consideration.

rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 13, 2021
@rivy
fix/CICD ~ repair broken cspell by pinning it to version v4.2.8
d579e6d 
## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 13, 2021
@rivy
maint/CICD ~ repair broken cspell by pinning it to version v4.2.8
d7cea71 
## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 13, 2021
@rivy
maint/CICD ~ (GHA) repair broken cspell by pinning it to version v4…
17e3172 
….2.8

## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 16, 2021
@rivy
maint/CICD ~ (GHA) repair broken cspell by pinning it to version v4…
3864c14 
….2.8

## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 17, 2021
@rivy
maint/CICD ~ (GHA) repair broken cspell by pinning it to version v4…
f73c327 
….2.8

## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 17, 2021
@rivy
maint/CICD ~ (GHA) repair broken cspell by pinning it to version v4…
26ef7e1 
….2.8

## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
rivy added a commit to rivy/rs.coreutils that referenced this issue Nov 20, 2021
@rivy
maint/CICD ~ (GHA) repair broken cspell by pinning it to version v4…
0b10e69 
….2.8

## [why]

`cspell` in CI started mysteriously failing mid-2021. Tracking down the
error took some time as it was not obvious from `cspell` feedback where
the issue lay. Ultimately, it was discovered that `cspell` had deprecated
use on NodeJS versions < v12 for `cspell` v5+.

`cspell` is now pinned to v4.2.8, with a maintenance note to allow an
upgrade to the `cspell` version when a version of NodeJS >= v12 is being
used in the CI.

An issue requesting better tool feedback for similar situations was also
opened on the `cspell` repo.[*]

[*]: [🙏🏻 Add warning (or error) when used on deprecated/outdated JS platform versions](streetsidesoftware/cspell#1984)
@Jason3S
Copy link
Collaborator

Jason3S commented Dec 17, 2021

I'm fine with a PR.

@rivy
Copy link
Contributor Author

rivy commented Dec 17, 2021 •
edited
Loading

Sure. I'll take a look.
Would you prefer a warning or an error?

rivy added a commit to rivy-t/cspell that referenced this issue Dec 17, 2021
@rivy
feat: report error and fail for unsupported NodeJS versions (streetsi…
7a567f7 
…desoftware#1984)
@rivy rivy mentioned this issue Dec 17, 2021
Merged
rivy added a commit to rivy-t/cspell that referenced this issue Dec 17, 2021
@rivy
feat: report error and fail for unsupported NodeJS versions (streetsi…
098012c 
…desoftware#1984)
rivy added a commit to rivy-t/cspell that referenced this issue Dec 17, 2021
@rivy
feat: report error and fail for unsupported NodeJS versions (streetsi…
f3ba0f3 
…desoftware#1984)
rivy added a commit to rivy-t/cspell that referenced this issue Dec 18, 2021
@rivy
feat: report error and fail for unsupported NodeJS versions (streetsi…
e2d2664 
…desoftware#1984)
Jason3S pushed a commit that referenced this issue Dec 18, 2021
@rivy
feat: report error and fail for unsupported NodeJS versions (#1984) (#…
52bb33e 
…2111)
@Jason3S
Copy link
Collaborator

Jason3S commented Dec 18, 2021

Close by #2111

@Jason3S Jason3S closed this as completed Dec 18, 2021
@Jason3S
Copy link
Collaborator

Jason3S commented Dec 18, 2021

@rivy,

Why roll back to cspell v4? I know it requires Node 12 and above, but the GitHub workflow allows you to easily use newer node versions. Is there someplace in your tooling that requires Node 10?

@rivy
Copy link
Contributor Author

rivy commented Dec 27, 2021

@Jason3S , I rolled back to cspell v4 to get spell-checking working with minimal extra effort.

I'll roll forward when either GitHub updates their VMs to newer NodeJS versions by default or when I get a chance to investigate the costs (code/time) of upgrading the test machines to a higher version of NodeJS.

@github-actions
Copy link
Contributor

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
enhancement new issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rivy @nschonni @Jason3S