Skip to content

chore: standardize npm script names#17431

Merged
nzakas merged 2 commits into
mainfrom
chore/npm-scripts-standardize
Aug 7, 2023
Merged

chore: standardize npm script names#17431
nzakas merged 2 commits into
mainfrom
chore/npm-scripts-standardize

Conversation

@snitin315

Copy link
Copy Markdown
Contributor

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:

What changes did you make? (Give an overview)

Refers #14827

This updates the names of the scripts in package.json to be consistent with the new standard.

Is there anything you'd like reviewers to focus on?

Is there any script we need to update in Netlify/jenkins?

@snitin315 snitin315 requested a review from a team as a code owner July 29, 2023 10:30
@eslint-github-bot eslint-github-bot Bot added the chore This change is not user-facing label Jul 29, 2023
@netlify

netlify Bot commented Jul 29, 2023

Copy link
Copy Markdown

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 8c8a563
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/64cd9d590641c50007b2faad
😎 Deploy Preview https://deploy-preview-17431--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@amareshsm amareshsm added the accepted There is consensus among the team that this change meets the criteria for inclusion label Jul 29, 2023

@amareshsm amareshsm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Waiting for code owner's review.

Comment thread docs/package.json Outdated
"lint:fix:scss": "npm run lint:scss -- --fix"
"lint:scss": "stylelint \"**/*.{scss,html}\"",
"lint:fix:scss": "npm run lint:scss -- --fix",
"minify:images": "imagemin '_site/assets/images' --out-dir='_site/assets/images'",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this should also be build?

Suggested change
"minify:images": "imagemin '_site/assets/images' --out-dir='_site/assets/images'",
"build:images": "imagemin '_site/assets/images' --out-dir='_site/assets/images'",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like we could have it as minify:images only? or it could be build:images:minify?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can update it to build:minify-images ,WDYT?

@nzakas

nzakas commented Aug 2, 2023

Copy link
Copy Markdown
Member

Just as a reminder, we do have documentation about naming conventions for these scripts:
https://github.com/eslint/eslint/blob/main/docs/src/contribute/package-json-conventions.md

@mdjermanovic mdjermanovic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! Leaving open for others to review.

@mdjermanovic

Copy link
Copy Markdown
Member

Is there any script we need to update in Netlify/jenkins?

I think we don't need to update anything on Netlify/Jenkins. Netlify only runs npm run build. I believe neither of the scripts from this package,json is run during the release process on Jenkins.

@harish-sethuraman harish-sethuraman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. leaving it open for @nzakas's review

@amareshsm amareshsm requested a review from nzakas August 7, 2023 10:04

@nzakas nzakas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@nzakas nzakas merged commit b066640 into main Aug 7, 2023
@nzakas nzakas deleted the chore/npm-scripts-standardize branch August 7, 2023 15:05
@eslint-github-bot eslint-github-bot Bot locked and limited conversation to collaborators Feb 4, 2024
@eslint-github-bot eslint-github-bot Bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants