mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-07-25 06:35:21 +00:00
299d52c517
# Description of Changes - **What was changed:** - Renamed top-level directories: `stirling-pdf` → `app/core`, `common` → `app/common`, `proprietary` → `app/proprietary`. - Updated all path references in `.gitattributes`, GitHub workflows (`.github/workflows/*`), scripts (`.github/scripts/*`), `.gitignore`, Dockerfiles, license files, and template settings to reflect the new structure. - Added a new CI job `check-generateOpenApiDocs` to generate and upload OpenAPI documentation. - Removed redundant `@Autowired` annotations from `TempFileShutdownHook` and `UnlockPDFFormsController`. - Minor formatting and comment adjustments in YAML templates and resource files. - **Why the change was made:** - To introduce a clear `app/` directory hierarchy for core, common, and proprietary modules, improving organization and maintainability. - To ensure continuous integration and Docker builds continue to work seamlessly with the reorganized structure. - To automate OpenAPI documentation generation as part of the CI pipeline. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
# STYLELINT.md
|
|
|
|
## Usage
|
|
|
|
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
|
|
npm install --save-dev @stylistic/stylelint-plugin
|
|
```
|
|
- Add a script entry to your `package.json`:
|
|
```jsonc
|
|
{
|
|
"scripts": {
|
|
"lint:css:check": "stylelint \"../app/core/src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config ../.stylelintrc.json",
|
|
"lint:css:fix": "stylelint \"../app/core//src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json --fix"
|
|
}
|
|
}
|
|
```
|
|
- Run the linter:
|
|
```bash
|
|
npm run lint:css:check
|
|
npm run lint:css:fix
|
|
```
|
|
|
|
2. **CLI Usage**
|
|
|
|
- Lint all CSS files:
|
|
```bash
|
|
npx stylelint ../app/core/src/main/**/*.css ../app/proprietary/src/main/resources/static/css/*.css
|
|
```
|
|
- Lint a single file:
|
|
```bash
|
|
npx stylelint ../app/proprietary/src/main/resources/static/css/audit-dashboard.css
|
|
```
|
|
- Apply automatic fixes:
|
|
```bash
|
|
npx stylelint "../app/core/src/main/**/*.css" "../app/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)
|
|
|