update 8 files

ioncakephper · ioncakephper · commit 13c870e48956 · 2025-06-26T23:50:24.000+03:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -25,11 +25,15 @@ jobs:
         run: npm ci
       - name: Lint code
         run: npm run lint
-      - name: Check formatting
-        run: npm run format
       - name: Lint Markdown files
         run: npm run lint:md
+      - name: Check formatting
+        run: npm run format
       - name: Check Markdown formatting
         run: npm run format:md
+      - name: Check Markdown links
+        run: npm run check:links
+      - name: Audit for vulnerabilities
+        run: npm audit --production
       - name: Run tests
         run: npm test
diff --git a/.gitignore b/.gitignore
@@ -17,4 +17,4 @@ coverage/
 .env.local
 .env.development.local
 .env.test.local
-.env.production.local
+.env.production.local
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -1,3 +1,4 @@
 {
-  "MD013": false
+    "MD013": false,
+    "default": true
 }
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -59,12 +59,11 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-<shytiger@yahoo.com>
-All complaints will be reviewed and investigated promptly and fairly.
+reported to the community leaders responsible for enforcement at [YOUR_PROJECT_CONTACT_EMAIL].
+_All complaints will be reviewed and investigated promptly and fairly_.
 
 All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
+_reporter of any incident._
 
 ## Enforcement Guidelines
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,7 +20,8 @@ Please take a moment to review this document to understand our contribution guid
 
 ## Code of Conduct
 
-This project and everyone participating in it is governed by the [js-quality-starter Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <shytiger@yahoo.com>.
+This project and everyone participating in it is governed by the [js-quality-starter Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [YOUR_PROJECT_CONTACT_EMAIL].
+
 
 ## How to Contribute
 
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # js-quality-starter
 
+[![Codecov](https://codecov.io/gh/YOUR_GITHUB_USERNAME/YOUR_REPO_NAME/branch/main/graph/badge.svg?token=YOUR_CODECOV_TOKEN)](https://codecov.io/gh/YOUR_GITHUB_USERNAME/YOUR_REPO_NAME)
+
+
+
 A template repository for modern JavaScript projects with pre-configured linting, formatting, testing, and CI/CD using GitHub Actions.
 
 This template provides a solid foundation for any new JavaScript project, ensuring code quality and consistency from the start.
@@ -10,12 +14,13 @@ This template comes pre-configured with a suite of modern, industry-standard too
 
 | Tool                                                      | Purpose                                                                                                                                  |
 | :-------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
-| **[ESLint](https://eslint.org/)**                         | Statically analyzes your code to quickly find and fix problems. It's configured with recommended rules to enforce best practices.        |
-| **[Prettier](https://prettier.io/)**                      | An opinionated code formatter that enforces a consistent style across your entire codebase, eliminating arguments over code style.       |
-| **[Jest](https://jestjs.io/)**                            | A delightful JavaScript Testing Framework with a focus on simplicity. It's set up and ready for you to write unit and integration tests. |
-| **[Husky](https://typicode.github.io/husky/)**            | Manages Git hooks to make it easy to run scripts at specific stages, like before a commit.                                               |
-| **[lint-staged](https://github.com/okonet/lint-staged)**  | Works with Husky to run linters and formatters on your staged files _before_ they are committed, ensuring no bad code gets in.           |
-| **[GitHub Actions](https://github.com/features/actions)** | Automates your workflow with two pre-configured CI pipelines for validating code on `main` and all other feature branches.               |
+| **ESLint**                         | Statically analyzes your code to quickly find and fix problems. It's configured with recommended rules to enforce best practices.        |
+| **Prettier**                      | An opinionated code formatter that enforces a consistent style across your entire codebase, eliminating arguments over code style.       |
+| **Jest**                            | A delightful JavaScript Testing Framework with a focus on simplicity. It's set up and ready for you to write unit and integration tests. |
+| **markdownlint** | A linter for Markdown files to enforce consistent style and catch common errors in documentation.                                        |
+| **Husky**            | Manages Git hooks to make it easy to run scripts at specific stages, like before a commit.                                               |
+| **lint-staged**  | Works with Husky to run linters and formatters on your staged files _before_ they are committed, ensuring no bad code gets in.           |
+| **GitHub Actions** | Automates your workflow with two pre-configured CI pipelines for validating code on `main` and all other feature branches.               |
 
 ## Getting Started
 
@@ -35,17 +40,23 @@ This template comes pre-configured with a suite of modern, industry-standard too
    cd your-new-repo
    ```
 
-   This will install all dependencies and also run the `prepare` script, which sets up the Husky pre-commit hooks automatically.
+2.  Install dependencies:
+    ```bash
+    npm install
+    ```
+    This will install all dependencies and also run the `prepare` script, which sets up the Husky pre-commit hooks automatically.
 
-2. Start coding!
+3. Start coding!
 
 ### Post-Template Setup
 
 After creating your repository from this template, be sure to:
 
 1. **Update `package.json`**: Change the `name`, `description`, and `author` fields.
 2. **Update `LICENSE`**: Modify the `[year]` and `[fullname]` to reflect your project's ownership.
-3. **Update `CODE_OF_CONDUCT.md` and `CONTRIBUTING.md`**: Replace the `[INSERT CONTACT EMAIL ADDRESS]` placeholder with a valid project contact email.
+3. **Update `CODE_OF_CONDUCT.md` and `CONTRIBUTING.md`**: Replace the `[YOUR_PROJECT_CONTACT_EMAIL]` placeholder with a valid project contact email.
+
+
 
 ## Available Scripts
 
@@ -56,6 +67,8 @@ In the project directory, you can run:
 - `npm run lint:fix`: Lints and automatically fixes fixable issues.
 - `npm run format`: Checks for formatting issues with Prettier.
 - `npm run format:fix`: Formats all supported files with Prettier.
+- `npm run lint:md`: Lints all Markdown files.
+- `npm run lint:md:fix`: Lints and automatically fixes fixable issues in Markdown files.
 - `npm run format:md`: Checks for formatting issues with Prettier for Markdown files.
 - `npm run format:md:fix`: Formats all Markdown files with Prettier.
 
@@ -78,23 +91,49 @@ Both workflows perform the following steps across multiple Node.js versions (18.
 
 1. **Install dependencies** using `npm ci` for fast, reliable installs.
 2. **Lint code** with `npm run lint`.
-3. **Check Markdown formatting** with `npm run format:md`.
-4. **Check formatting** with `npm run format`.
-5. **Run tests** with `npm test`.
+3.  **Lint Markdown files** with `npm run lint:md`.
+4.  **Check code formatting** with `npm run format`.
+5.  **Check Markdown formatting** with `npm run format:md`.
+6.  **Check for broken links** in Markdown with `npm run check:links`.
+7.  **Audit for vulnerabilities** with `npm audit --production`.
+8.  **Run tests** with `npm test`.
+
+
 
 ## Customization
 
 This template is a starting point. You can easily customize it to fit your project's needs:
 
 - **Linting Rules**: Modify the `.eslintrc.js` file to add or change ESLint rules.
 - **Formatting Options**: Adjust the `.prettierrc` file to change Prettier's formatting options.
+- **Markdown Linting**: Customize `markdownlint` rules by editing the `.markdownlint.json` file.
 - **Testing**: The `jest.config.js` file can be configured for more advanced testing scenarios.
 - **CI/CD**: Edit the workflow files in `.github/workflows` to add new steps, such as deployment or notifications.
 
+## Code Coverage
+
+This template is configured to generate code coverage reports using Jest. The reports are output to the `coverage/` directory in various formats, including `lcov`, which is compatible with popular code coverage services.
+
+To get a dynamic code coverage badge like the one at the top of this `README.md`, you can integrate with a service like Codecov or Coveralls.
+
+**Steps to set up Codecov (example):**
+1.  Sign up for Codecov with your GitHub account.
+2.  Add your repository to Codecov.
+3.  Codecov will provide you with a `CODECOV_TOKEN`. Add this token as a secret in your GitHub repository settings (e.g., `CODECOV_TOKEN`).
+4.  Add a step to your CI workflow (`.github/workflows/ci.yml`) to upload the coverage report to Codecov. This typically involves adding a step like:
+    ```yaml
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+    ```
+5.  Update the badge URL in `README.md` with your specific repository details and token (if required by Codecov for public repos, though often not for public repos).
+
+
 ## Contributing
 
 We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines on how to contribute, report bugs, and suggest enhancements.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
+This project is licensed under the [LICENSE](LICENSE.md) file for details.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`{`
`2`		`- "MD013": false`
	`2`	`+ "MD013": false,`
	`3`	`+ "default": true`
`3`	`4`	`}`