@kouts/eslint-config 1.3.0 → 1.3.2

package/.github/workflows/release.yml

@@ -0,0 +1,77 @@
+name: release
+
+on:
+  push:
+    branches: [main, beta]
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [20]
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup node env 🏗
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          check-latest: true
+
+      - name: Setup pnpm 📦
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.7.1
+
+      - name: Install dependencies 📦
+        run: pnpm install
+
+      - name: Run linter 👀
+        run: pnpm run lint-fix
+
+      - name: Build ⚙️
+        run: pnpm run build
+  release:
+    runs-on: ${{ matrix.os }}
+    needs: ci
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [20]
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup node env 🏗
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          check-latest: true
+
+      - name: Setup pnpm 📦
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.7.1
+
+      - name: Install dependencies 📦
+        run: pnpm install
+
+      - name: Install semantic-release extra plugins 📦
+        run: pnpm install --save-dev semantic-release @semantic-release/changelog @semantic-release/git
+
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

package/.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

package/.nvmrc

@@ -0,0 +1 @@
+v20

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+## [1.3.2](https://github.com/kouts/eslint-config/compare/v1.3.1...v1.3.2) (2024-08-18)
+
+
+### Bug Fixes
+
+* removed files from package.json ([881949b](https://github.com/kouts/eslint-config/commit/881949b7c353fc9ed0ed09106f91b450c28b78d1))
+
+## [1.3.1](https://github.com/kouts/eslint-config/compare/v1.3.0...v1.3.1) (2024-08-18)
+
+
+### Bug Fixes
+
+* added build step ([1e9d478](https://github.com/kouts/eslint-config/commit/1e9d4786e58aa4265d21440628a4200abfed2883))
+
+# [1.3.0](https://github.com/kouts/eslint-config/compare/v1.2.0...v1.3.0) (2024-08-17)
+
+
+### Features
+
+* added vitest plugin ([b39e526](https://github.com/kouts/eslint-config/commit/b39e526a10b5e80d60b02e7f31293eb3d05f7bfa))

package/README_V0.md

@@ -0,0 +1,76 @@
+# @kouts/eslint-config
+
+> Custom ESLint and Prettier config with sensible defaults
+
+## Installation
+
+```bash
+npm i -D @kouts/eslint-config eslint prettier
+```
+
+## Usage
+
+There are 4 ESLint config presets that you can use:
+
+- `@kouts/eslint-config/javascript` for JavaScript / TypeScript projects
+- `@kouts/eslint-config/vue2` for Vue.js 2 projects
+- `@kouts/eslint-config/vue3` for Vue.js 3 projects
+- `@kouts/eslint-config/vue3-typescript` for Vue.js 3 / TypeScript projects
+- `@kouts/eslint-config/nuxt3` for Nuxt 3 projects
+
+Add the desired config preset into your `.eslintrc.js` file:
+
+```javascript
+module.exports = {
+  extends: ['@kouts/eslint-config/vue2']
+}
+```
+
+Add a `prettier.config.js` file with contents:
+
+```javascript
+module.exports = require('@kouts/eslint-config/prettier.config.js')
+```
+
+You can add ESLint commands to `.package-json`
+
+```json
+{
+  "lint": "eslint \"**/*.{vue,ts,js}\"",
+  "lint-fix": "eslint --fix \"**/*.{vue,ts,js}\""
+}
+```
+
+and VS Code settings for autofix on save
+
+`.vscode/settings.json`
+
+```json
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}
+```
+
+## Features
+
+- Based on [eslint-config-standard](https://github.com/standard/eslint-config-standard)
+- [Prettier](https://prettier.io) for code formatting
+- Plugins
+  - [eslint-plugin-html](https://github.com/BenoitZugmeyer/eslint-plugin-html) for linting inline scripts contained in HTML files
+  - [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue/) for linting Vue.js files
+  - [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) for disabling all rules that conflict with Prettier
+  - [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) for using prettier as a code formatter for `eslint --fix`
+  - [sort-imports-es6-autofix](https://github.com/marudor/eslint-plugin-sort-imports-es6-autofix) for auto-fixing imports order
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

package/commitlint.config.js

@@ -0,0 +1,6 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-max-line-length': [1, 'always', 5000],
+  },
+}

package/eslint.config.js

@@ -0,0 +1,8 @@
+import { config } from './dist/index.js'
+
+export default [
+  ...config(),
+  {
+    ignores: ['fixtures/**'],
+  },
+]

package/eslint.config.ts

@@ -0,0 +1,3 @@
+import { config } from './src'
+
+export default config()

package/fixtures/vue3-ts-vite-starter-template/.nvmrc

@@ -0,0 +1 @@
+v20

package/fixtures/vue3-ts-vite-starter-template/README.md

@@ -0,0 +1,2 @@
+This is a fixture cloned from https://github.com/kouts/vue3-ts-vite-starter-template.  
+It uses the lint config from the parent directory to test linting.

package/fixtures/vue3-ts-vite-starter-template/env.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="vite/client" />
+
+declare module '*.vue' {
+  import { type DefineComponent } from 'vue'
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const component: DefineComponent<object, object, any>
+  export default component
+}

package/fixtures/vue3-ts-vite-starter-template/eslint.config.js

@@ -0,0 +1,12 @@
+import { config } from '@kouts/eslint-config'
+
+export default [
+  ...config(),
+  {
+    // Disable multi-word-component-names for pages and layouts
+    files: ['src/views/**/*.vue', 'src/layouts/**/*.vue'],
+    rules: {
+      'vue/multi-word-component-names': 'off',
+    },
+  },
+]

package/fixtures/vue3-ts-vite-starter-template/index.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta name="description" content="<%= description %>">
+  <link rel="icon" href="/favicon.ico">
+  <link rel="preconnect" href="https://fonts.googleapis.com">
+  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap" rel="stylesheet">
+  <title>
+    <%= title %>
+  </title>
+</head>
+
+<body>
+  <noscript>
+    <strong>
+      we're sorry but <%= title %> doesn't work properly without JavaScript enabled. Please enable it to continue.
+    </strong>
+  </noscript>
+  <div id="app"></div>
+  <script type="module" src="/src/main.ts"></script>
+</body>
+
+</html>

package/fixtures/vue3-ts-vite-starter-template/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "vue3-ts-vite-starter-template",
+  "description": "Vue.js 3 TypeScript / Vite starter template with Pinia, Vue Router, Tailwind and more.",
+  "version": "0.0.0-semantic-release",
+  "license": "MIT",
+  "repository": "https://github.com/kouts/vue3-ts-vite-starter-template",
+  "packageManager": "pnpm@9.7.1",
+  "type": "module",
+  "scripts": {
+    "preinstall": "npx only-allow pnpm",
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "lint": "eslint \"**/*.{vue,ts,js}\"",
+    "lint-fix": "eslint --fix \"**/*.{vue,ts,js}\"",
+    "test:unit": "vitest",
+    "test:unit-coverage": "vitest run --coverage",
+    "typecheck": "vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "pinia": "^2.2.2",
+    "vue": "^3.4.38",
+    "vue-router": "^4.4.3"
+  },
+  "devDependencies": {
+    "@fullhuman/postcss-purgecss": "^6.0.0",
+    "@fullhuman/vue-cli-plugin-purgecss": "^6.0.0",
+    "@kouts/eslint-config": "link:../..",
+    "@types/jsdom": "^21.1.7",
+    "@types/node": "^22.4.0",
+    "@vitejs/plugin-vue": "^5.1.2",
+    "@vitest/coverage-v8": "^2.0.5",
+    "@vue/compiler-sfc": "^3.4.38",
+    "@vue/test-utils": "^2.4.6",
+    "autoprefixer": "^10.4.20",
+    "eslint": "^9.9.0",
+    "jsdom": "^24.1.1",
+    "prettier": "^3.3.3",
+    "prettier-plugin-tailwindcss": "^0.6.6",
+    "sass": "^1.77.8",
+    "tailwindcss": "^3.4.10",
+    "typescript": "^5.5.4",
+    "vite": "^5.4.1",
+    "vitest": "^2.0.5",
+    "vue-tsc": "^2.0.29"
+  },
+  "resolutions": {
+    "@typescript-eslint/utils": "^8.1.0"
+  }
+}