From bebb5c795120c89d48b7d3d5ae155290729e7232 Mon Sep 17 00:00:00 2001 From: Ludy87 Date: Thu, 10 Jul 2025 18:18:04 +0200 Subject: [PATCH] move to devTools --- .vscode/settings.json | 2 +- devGuide/STYLELINT.md | 14 +++++++++----- .stylelintrc.json => devTools/.stylelintrc.json | 0 package-lock.json => devTools/package-lock.json | 0 devTools/package.json | 13 +++++++++++++ package.json | 12 ------------ 6 files changed, 23 insertions(+), 18 deletions(-) rename .stylelintrc.json => devTools/.stylelintrc.json (100%) rename package-lock.json => devTools/package-lock.json (100%) create mode 100644 devTools/package.json delete mode 100644 package.json diff --git a/.vscode/settings.json b/.vscode/settings.json index 187af68fa..03d51b765 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -125,7 +125,7 @@ "html.format.indentHandlebars": true, "html.format.preserveNewLines": true, "html.format.maxPreserveNewLines": 2, - "stylelint.configFile": ".stylelintrc.json", + "stylelint.configFile": "devTools/.stylelintrc.json", "java.project.sourcePaths": [ "stirling-pdf/src/main/java", "common/src/main/java", diff --git a/devGuide/STYLELINT.md b/devGuide/STYLELINT.md index a5c89939d..27bc4da4d 100644 --- a/devGuide/STYLELINT.md +++ b/devGuide/STYLELINT.md @@ -6,6 +6,8 @@ Apply Stylelint to your project's CSS with the following steps: 1. **NPM Script** + - Go to directory: `devTools/` + - Add Stylelint & stylistic/stylelint-plugin ```bash npm install --save-dev stylelint stylelint-config-standard @@ -15,28 +17,30 @@ Apply Stylelint to your project's CSS with the following steps: ```jsonc { "scripts": { - "lint:css": "stylelint \"stirling-pdf/src/main/**/*.css\" \"proprietary/src/main/resources/static/css/*.css\" --fix" + "lint:css:check": "stylelint \"../stirling-pdf/src/main/**/*.css\" \"../proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json", + "lint:css:fix": "stylelint \"../stirling-pdf/src/main/**/*.css\" \"../proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json --fix" } } ``` - Run the linter: ```bash - npm run lint:css + npm run lint:css:check + npm run lint:css:fix ``` 2. **CLI Usage** - Lint all CSS files: ```bash - npx stylelint "stylelint \"stirling-pdf/src/main/**/*.css\" \"proprietary/src/main/resources/static/css/*.css\"" + npx stylelint ../stirling-pdf/src/main/**/*.css ../proprietary/src/main/resources/static/css/*.css ``` - Lint a single file: ```bash - npx stylelint path/to/file.css + npx stylelint ../proprietary/src/main/resources/static/css/audit-dashboard.css ``` - Apply automatic fixes: ```bash - npx stylelint "stirling-pdf/src/main/**/*.css" "proprietary/src/main/resources/static/css/*.css" --fix + npx stylelint "../stirling-pdf/src/main/**/*.css" "../proprietary/src/main/resources/static/css/*.css" --fix ``` For full configuration options and rule customization, refer to the official documentation: [https://stylelint.io](https://stylelint.io) diff --git a/.stylelintrc.json b/devTools/.stylelintrc.json similarity index 100% rename from .stylelintrc.json rename to devTools/.stylelintrc.json diff --git a/package-lock.json b/devTools/package-lock.json similarity index 100% rename from package-lock.json rename to devTools/package-lock.json diff --git a/devTools/package.json b/devTools/package.json new file mode 100644 index 000000000..e58ed4df0 --- /dev/null +++ b/devTools/package.json @@ -0,0 +1,13 @@ +{ + "name": "stirling-pdf", + "version": "1.0.0", + "scripts": { + "lint:css:check": "stylelint \"../stirling-pdf/src/main/**/*.css\" \"../proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json", + "lint:css:fix": "stylelint \"../stirling-pdf/src/main/**/*.css\" \"../proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json --fix" + }, + "devDependencies": { + "@stylistic/stylelint-plugin": "^3.1.3", + "stylelint": "^16.21.1", + "stylelint-config-standard": "^38.0.0" + } +} diff --git a/package.json b/package.json deleted file mode 100644 index e7f69e0f5..000000000 --- a/package.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "name": "stirling-pdf", - "version": "1.0.0", - "scripts": { - "lint:css": "stylelint \"stirling-pdf/src/main/**/*.css\" \"proprietary/src/main/resources/static/css/*.css\" --fix" - }, - "devDependencies": { - "@stylistic/stylelint-plugin": "^3.1.3", - "stylelint": "^16.21.1", - "stylelint-config-standard": "^38.0.0" - } -}