From f358e9fd134cbf378b155c57e78f62849492cfca Mon Sep 17 00:00:00 2001 From: Michaelyin Date: Thu, 25 Apr 2024 11:02:04 +0800 Subject: [PATCH] chore --- CHANGELOG.md | 6 ++++++ docs/CHANGELOG.md | 1 + docs/linting.md | 23 +++++++++++++++++++++++ mkdocs.yml | 2 ++ 4 files changed, 32 insertions(+) create mode 120000 docs/CHANGELOG.md create mode 100644 docs/linting.md diff --git a/CHANGELOG.md b/CHANGELOG.md index d843cc0..45fae52 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## v1.0.3 + +1. Remove `Bootstrap` from the default setup. +2. Update doc about `Bootstrap`, `SWC`, `React`, `Vue` +6. Update frontend dependency to the latest version + ## v1.0.2 1. Support Node LTS Iron diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 120000 index 0000000..04c99a5 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1 @@ +../CHANGELOG.md \ No newline at end of file diff --git a/docs/linting.md b/docs/linting.md new file mode 100644 index 0000000..bd0f9d5 --- /dev/null +++ b/docs/linting.md @@ -0,0 +1,23 @@ +# Code Linting + +Code linting on the frontend can guarantee the code quality and make the code more readable. + +We use `eslint` and `stylelint` to lint the code, and you can just use them out of the box. + +## ESLint + +ESLint is a static code analysis tool for identifying problematic patterns found in JavaScript code. It helps maintain code quality by enforcing coding standards and best practices. Some benefits of using ESLint include: + +- **Code Consistency:** ESLint ensures that all code in the project follows the same style and guidelines, making it easier for developers to collaborate. +- **Error Prevention:** It helps catch common programming errors and potential bugs during development. +- **Customizable Rules:** ESLint allows you to configure rules based on your project's specific requirements. +- **Integration:** ESLint can be easily integrated into various build tools and IDEs. + +## Stylelint + +Stylelint is a linting tool for CSS and SCSS that helps maintain consistent coding styles and prevents errors in your stylesheets. Some benefits of using Stylelint include: + +- **Consistent Styles:** Stylelint enforces consistent coding styles across your stylesheets, ensuring a uniform look and feel. +- **Error Detection:** It helps identify errors and potential issues in your CSS code. +- **Customizable Configuration:** Stylelint allows you to configure rules and plugins to suit your project's needs. +- **Integration:** Stylelint can be seamlessly integrated into your build process and editor. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1575a87..f37b87e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,6 +18,7 @@ nav: - Setup With Django: setup_with_django.md - Setup With Flask: setup_with_flask.md - Frontend workflow: frontend.md + - Code Linting: linting.md - Live Reload: live_reload.md - Tailwind CSS: setup_with_tailwind.md - Bootstrap: setup_with_bootstrap.md @@ -28,3 +29,4 @@ nav: - Typescript: typescript.md - Deployment Notes: deployment.md - Run NPM command at root directory: run_npm_command_at_root.md + - Change Log: CHANGELOG.md