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

[Meta] Drop format, lint, check-format and check-lint commands, replace them with check and ci commands #2428

Merged
merged 1 commit into from
Dec 5, 2024
Merged

[Meta] Drop format, lint, check-format and check-lint commands, replace them with check and ci commands #2428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ jobs:
restore-keys: |
${{ runner.os }}-yarn-
- run: yarn --immutable
- run: yarn check-lint
- run: yarn check-format
- run: yarn ci

js-dist-current:
name: Check for UnBuilt JS Dist Files
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,14 @@ To help you with assets, you can run the following commands in a specific packag
- `yarn run build`: build (compile) assets from the package,
- `yarn run watch`: watch for modifications and rebuild assets from the package,
- `yarn run test`: run the tests from the package,
- `yarn run lint`: lint assets from the package,
- `yarn run format`: format assets from the package.
- `yarn run check`: run the formatter, linter, and sort imports, and fails if any modifications
- `yarn run check --write`: run the formatter, linter, imports sorting, and write modifications
Copy link
Contributor

Choose a reason for hiding this comment

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

I forgot to update the contributing guide 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

Nah, don't worry that's fine :)


Thanks to [Yarn Workspaces](https://yarnpkg.com/features/workspaces), you can also run these commands from the root directory of the project:
- `yarn run build`: build (compile) assets from **all** packages,
- `yarn run test`: run the tests from **all** packages,
- `yarn run lint`: lint assets from **all** packages,
- `yarn run format`: format assets from **all** packages,
- `yarn run check`: run the formatter, linter, and sort imports for **all** packages, and fails if any modifications
- `yarn run check --write`: run the formatter, linter, imports sorting for **all** packages, and write modifications

## Useful Git commands

Expand Down
6 changes: 2 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@
"scripts": {
"build": "yarn workspaces foreach -Apt run build",
"test": "yarn workspaces foreach -Apt run test",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"devDependencies": {
"@babel/core": "^7.25.2",
Expand Down
6 changes: 2 additions & 4 deletions src/Autocomplete/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Chartjs/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Cropperjs/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Dropzone/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/LazyImage/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/LiveComponent/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Map/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"importmap": {
Expand Down
6 changes: 2 additions & 4 deletions src/Map/src/Bridge/Google/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
"build": "node ../../../../../../bin/build_package.js .",
"watch": "node ../../../../../../bin/build_package.js . --watch",
"test": "../../../../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Map/src/Bridge/Leaflet/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
"build": "node ../../../../../../bin/build_package.js .",
"watch": "node ../../../../../../bin/build_package.js . --watch",
"test": "../../../../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Notify/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/React/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/StimulusBundle/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"needsPackageAsADependency": false,
Expand Down
6 changes: 2 additions & 4 deletions src/Svelte/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Swup/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/TogglePassword/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Translator/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"importmap": {
Expand Down
6 changes: 2 additions & 4 deletions src/Turbo/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Typed/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
6 changes: 2 additions & 4 deletions src/Vue/assets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@
"build": "node ../../../bin/build_package.js .",
"watch": "node ../../../bin/build_package.js . --watch",
"test": "../../../bin/test_package.sh .",
"lint": "biome lint --write",
"format": "biome format --write",
"check-lint": "biome lint",
"check-format": "biome format"
"check": "biome check",
"ci": "biome ci"
},
"symfony": {
"controllers": {
Expand Down
Loading