Merge branch 'master' into main

Author: coderwyd

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@coderwyd"
+}

.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - run: npx changelogithub
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1,80 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# Nuxt generate
+dist
+
+# Serverless directories
+.serverless
+
+# IDE
+.idea
+
+*.lerna_backup

.npmrc

@@ -0,0 +1,2 @@
+strict-peer-dependencies=false
+shamefully-hoist=true

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["bumpp", "coderwyd"]
+}

LICENSE

@@ -1,6 +1,10 @@
 MIT License
 
+<<<<<<< HEAD
 Copyright (c) 2023 Donny Wang
+=======
+Copyright (c) 2019-PRESENT Anthony Fu<https://github.com/coderwyd>
+>>>>>>> master
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,125 @@
+# @coderwyd/eslint-config
+
+- Single quotes, no semi
+- Auto fix for formatting (aimed to be used standalone **without** Prettier)
+- Designed to work with TypeScript, Vue out-of-box
+- Lint also for json, yaml, markdown
+- Sorted imports, dangling commas
+- Reasonable defaults, best practices, only one-line of config
+- **Style principle**: Minimal for reading, stable for diff
+
+## Usage
+
+### Install
+
+```bash
+pnpm add -D eslint @coderwyd/eslint-config
+```
+
+### Config `.eslintrc`
+
+```json
+{
+  "extends": "@coderwyd"
+}
+```
+
+> You don't need `.eslintignore` normally as it has been provided by the preset.
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+### VS Code support (auto fix)
+
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+Add the following settings to your `settings.json`:
+
+```jsonc
+{
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true,
+    "source.organizeImports": false
+  },
+
+  // The following is optional.
+  // It's better to put under project setting `.vscode/settings.json`
+  // to avoid conflicts with working with different eslint configs
+  // that does not support all formats.
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact", "vue", "html", "markdown", "json", "jsonc", "yaml"]
+}
+```
+
+### TypeScript Aware Rules
+
+Type aware rules are enabled when a `tsconfig.eslint.json` is found in the project root, which will introduce some stricter rules into your project. If you want to enable it while have no `tsconfig.eslint.json` in the project root, you can change tsconfig name by modifying `ESLINT_TSCONFIG` env.
+
+```js
+// .eslintrc.js
+const process = require('node:process')
+process.env.ESLINT_TSCONFIG = 'tsconfig.json'
+
+module.exports = {
+  extends: '@coderwyd',
+}
+```
+
+### Lint Staged
+
+If you want to apply lint and auto-fix before every commit, you can add the following to your `package.json`:
+
+```json
+{
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}
+```
+
+and then
+
+```bash
+npm i -D lint-staged simple-git-hooks
+```
+
+## Badge
+
+If you enjoy this code style, and would like to mention it in your project, here is the badge you can use:
+
+## FAQ
+
+### I prefer XXX...
+
+Sure, you can override the rules in your `.eslintrc` file.
+
+<!-- eslint-skip -->
+
+```jsonc
+{
+  "extends": "@coderwyd",
+  "rules": {
+    // your rules...
+  }
+}
+```
+
+Or you can always fork this repo and make your own.
+
+## License
+
+[MIT](./LICENSE) License &copy; 2019-PRESENT [Donny Wang](https://github.com/coderwyd)

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@coderwyd/eslint-config-monorepo",
+  "version": "1.0.0",
+  "private": true,
+  "packageManager": "pnpm@8.6.7",
+  "author": "Donny Wang <donny526@outlook.com> (https://github.com/coderwyd/)",
+  "license": "MIT",
+  "scripts": {
+    "lint": "pnpm -r run stub && eslint .",
+    "test": "pnpm -r run test",
+    "build": "pnpm -r run build",
+    "prepare": "pnpm -r run stub",
+    "release": "bumpp -r && pnpm -r publish"
+  },
+  "devDependencies": {
+    "@coderwyd/eslint-config": "workspace:*",
+    "bumpp": "^9.1.1",
+    "eslint": "^8.45.0",
+    "eslint-plugin-coderwyd": "link:./packages/eslint-plugin-coderwyd",
+    "rimraf": "^5.0.1",
+    "typescript": "^5.1.6"
+  }
+}