@lqbach/eslint-config 0.3.4 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.4.0](https://github.com/lqbach/eslint-prettier-config/compare/eslint-config-v0.3.4...eslint-config-v0.4.0) (2023-12-04)
+
+
+### Features 🚀
+
+* add ignores parameter ([bd6a304](https://github.com/lqbach/eslint-prettier-config/commit/bd6a304555afa3b8371f3e22cf78ab6936d8770c))
+* add README to `eslint-config` package ([#11](https://github.com/lqbach/eslint-prettier-config/issues/11)) ([8bcf82d](https://github.com/lqbach/eslint-prettier-config/commit/8bcf82dd94ceeb5f42e5807b46a682586e41b937))
+
 ## [0.3.4](https://github.com/lqbach/eslint-prettier-config/compare/eslint-config-v0.3.3...eslint-config-v0.3.4) (2023-11-28)
 
 

package/README.md

@@ -10,3 +10,103 @@
     <img src="https://img.shields.io/github/release-date/lqbach/eslint-prettier-config?labelColor=BDD4E7&color=444E5F" alt="release-date"/>
 
 </div>
+
+- [Usage](#usage)
+  - [Installation](#installation)
+    - [pnpm](#pnpm)
+    - [yarn](#yarn)
+    - [npm](#npm)
+  - [Setup](#setup)
+  - [VSCode Support](#vscode-support)
+- [Features](#features)
+  - [Ignoring Files](#ignoring-files)
+  - [React and Vue](#react-and-vue)
+
+## Usage
+
+### Installation
+
+#### pnpm
+
+```
+pnpm add -D @lqbach/eslint-config eslint
+```
+
+#### yarn
+
+```
+yarn add -D @lqbach/eslint-config eslint
+```
+
+#### npm
+
+```
+npm install -D @lqbach/eslint-config eslint
+```
+
+### Setup
+
+This configuration file uses the new [flat ESLint Configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new). Setting this up can be as seamless as one line of code.
+
+```js
+// eslint.config.js
+import eslintConfig from "@lqbach/eslint-config"
+
+export default eslintConfig()
+```
+
+> [!WARNING]  
+> ESLint flat configs don't really support `.eslintignore` files anymore. To ignore files, you should use the new global `ignores` that can be easily configured with this config library See [ignoring files](#ignoring-files) below.
+
+### VSCode Support
+
+Visual Studio Code has an [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) (or search _`dbaeumer.vscode-eslint`_ in the Extension Marketplace search bar) that supports rich editing features. This will help lint file saves and provide linting documentation in the code.
+The following should be added to `.vscode/settings.json` at the root of your project:
+
+```json
+{
+  // Include the below if using Prettier
+  //   "editor.formatOnSave": true,
+
+  // Tell the ESLint plugin to run on save
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+
+  // To enable proper ESLint behavior with flat configurations
+  "eslint.experimental.useFlatConfig": true
+}
+```
+
+## Features
+
+### Ignoring Files
+
+You can ignore files by using the `ignores` parameter which accepts an array of strings. Reference the [ignore patterns](https://eslint.org/docs/latest/use/configure/ignore) from the ESLint documentation for proper glob syntax.
+
+```js
+// eslint.config.js
+import eslintConfig from "@lqbach/eslint-config"
+
+export default eslintConfig({
+  ignores: ["./sanity", "./public/*.js"],
+})
+```
+
+The above will ignore the `sanity` folder and all JavaScript files in the `public` folder.
+
+### React and Vue
+
+If you are writing with React or Vue, you will need to toggle them on. Both `vue` and `react` parameters default to `false` until set by the user.
+
+```js
+// eslint.config.js
+import eslintConfig from "@lqbach/eslint-config"
+
+export default eslintConfig({
+  vue: true, // defaults to false
+
+  // uncomment below and comment above to use react
+  // react: true,
+})
+```

package/dist/index.cjs

@@ -369,7 +369,8 @@ function config(params = {}) {
       "**/.cache",
       "**/.output",
       "**/*.min.*",
-      "**/LICENSE*"
+      "**/LICENSE*",
+      ...params.ignores ? params.ignores : []
     ]
   };
   const javascriptConfig = [

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 interface ConfigParams {
+    ignores?: Array<string>;
     json?: boolean;
     markdown?: boolean;
     perfectionist?: boolean;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 interface ConfigParams {
+    ignores?: Array<string>;
     json?: boolean;
     markdown?: boolean;
     perfectionist?: boolean;

package/dist/index.js

@@ -358,7 +358,8 @@ function config(params = {}) {
       "**/.cache",
       "**/.output",
       "**/*.min.*",
-      "**/LICENSE*"
+      "**/LICENSE*",
+      ...params.ignores ? params.ignores : []
     ]
   };
   const javascriptConfig = [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lqbach/eslint-config",
   "type": "module",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "lqbach's Personal Eslint Config",
   "private": false,
   "license": "MIT",
@@ -34,7 +34,7 @@
     "vue-eslint-parser": "^9.3.2",
     "yaml-eslint-parser": "^1.2.2"
   },
-  "devDependencies": {
+  "peerDependencies": {
     "eslint": "^8.53.0"
   },
   "scripts": {

package/src/index.ts

@@ -41,6 +41,7 @@ export default function config(params: ConfigParams = {}): Array<ConfigObject> {
 
       "**/*.min.*",
       "**/LICENSE*",
+      ...(params.ignores ? params.ignores : []),
     ],
   }
 

package/src/types.ts

@@ -1,4 +1,5 @@
 export interface ConfigParams {
+  ignores?: Array<string>
   json?: boolean
   markdown?: boolean
   perfectionist?: boolean