Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Igor Kowalski committed Aug 6, 2024
1 parent e6fb037 commit 1c6d115
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion documentation/migration-to-2.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A minor configuration fix will be required for version <= 1.4.7.

### General changes:

- The entire documentation has been rewritten for ESLint's new config system. Examples with the old ESLint configuration can be found in the [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
- The entire documentation has been rewritten for ESLint's new config system. Examples with the old ESLint configuration can be found in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
- New option for creating a configuration file in an .mjs file with TypeScript support.
- You can now use comments in folderStructure.json and independentModules.json files.
- Improved error messages for folder-structure.
Expand Down
5 changes: 3 additions & 2 deletions documentation/project-structure-folder-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,11 @@ npm i --dev eslint-plugin-project-structure
Add the following lines to **`eslint.config.mjs`**.

> [!NOTE]
> The examples in the documentation refer to ESLint's new config system. If you're interested in examples for the old ESLint config, you can find them in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure.
> The examples in the documentation refer to ESLint's new config system. If you're interested in examples for the old ESLint config, you can find them in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
```mjs
// @ts-check

import eslint from "@eslint/js";
import tseslint from "typescript-eslint";
import {
Expand Down Expand Up @@ -140,7 +141,7 @@ export default tseslint.config(
Create a **`folderStructure.mjs`** in the root of your project.<br>

> [!NOTE]
> **`folderStructure.json`** and **`folderStructure.yaml`** are also supported. See an example in the [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground).
> **`folderStructure.json`** and **`folderStructure.yaml`** are also supported. See an example in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
#### Simple example for the structure below:

Expand Down
4 changes: 2 additions & 2 deletions documentation/project-structure-independent-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ npm i --dev eslint-plugin-independent-modules
Add the following lines to **`eslint.config.mjs`**.

> [!NOTE]
> The examples in the documentation refer to ESLint's new config system. If you're interested in examples for the old ESLint config, you can find them in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure.
> The examples in the documentation refer to ESLint's new config system. If you're interested in examples for the old ESLint config, you can find them in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
```mjs
// @ts-check
Expand Down Expand Up @@ -103,7 +103,7 @@ export default tseslint.config({
Create a **`independentModules.mjs`** in the root of your project.<br>

> [!NOTE]
> **`independentModules.json`** and **`independentModules.yaml`** are also supported. See an example in the [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground).
> **`independentModules.json`** and **`independentModules.yaml`** are also supported. See an example in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
#### Simple example for the folder structure below:

Expand Down
2 changes: 1 addition & 1 deletion documentation/project-structure-naming-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ npm i --dev eslint-plugin-project-structure
Add the following lines to **`eslint.config.mjs`**.

> [!NOTE]
> The examples in the documentation refer to ESLint's new config system. If you're interested in examples for the old ESLint config, you can find them in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure.
> The examples in the documentation refer to ESLint's new config system. If you're interested in examples for the old ESLint config, you can find them in the [**playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
```mjs
// @ts-check
Expand Down

0 comments on commit 1c6d115

Please sign in to comment.