@djangocfg/eslint-config 1.4.17 → 1.4.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +75 -26
  2. package/package.json +26 -2
package/README.md CHANGED
@@ -1,43 +1,92 @@
1
1
  # @djangocfg/eslint-config
2
2
 
3
- Shared ESLint configuration for the monorepo.
3
+ > Shared ESLint configurations for Next.js, React, and TypeScript projects with best practices and Prettier integration
4
4
 
5
- ## What's Inside
5
+ [![npm version](https://img.shields.io/npm/v/@djangocfg/eslint-config.svg)](https://www.npmjs.com/package/@djangocfg/eslint-config)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6
7
 
7
- - **Base Config** - Core ESLint rules
8
- - **Next.js Config** - Next.js specific rules
9
- - **React Config** - React best practices
8
+ **Part of [DjangoCFG](https://djangocfg.com)** — a modern Django framework for building production-ready SaaS applications. All `@djangocfg/*` packages are designed to work together, providing type-safe configuration, real-time features, and beautiful admin interfaces out of the box.
9
+
10
+ ---
11
+
12
+ ## Overview
13
+
14
+ `@djangocfg/eslint-config` provides battle-tested ESLint configurations for modern JavaScript and TypeScript projects. It includes presets for Next.js applications, React libraries, and general TypeScript projects.
15
+
16
+ ## Features
17
+
18
+ - **Next.js Preset** - Optimized rules for Next.js App Router
19
+ - **React Preset** - React hooks and JSX best practices
20
+ - **TypeScript Support** - Full typescript-eslint integration
21
+ - **Prettier Compatible** - Works seamlessly with Prettier
22
+ - **Turbo Support** - Turborepo-aware caching rules
23
+ - **ESLint 9** - Uses flat config format
24
+
25
+ ## Installation
26
+
27
+ ```bash
28
+ npm install -D @djangocfg/eslint-config eslint
29
+ # or
30
+ pnpm add -D @djangocfg/eslint-config eslint
31
+ # or
32
+ yarn add -D @djangocfg/eslint-config eslint
33
+ ```
10
34
 
11
35
  ## Usage
12
36
 
13
- ### Next.js App
37
+ ### Next.js Projects
14
38
 
15
- ```json
16
- {
17
- "extends": ["@djangocfg/eslint-config/next"]
18
- }
39
+ ```js
40
+ // eslint.config.mjs
41
+ import nextConfig from '@djangocfg/eslint-config/next-js';
42
+
43
+ export default nextConfig;
19
44
  ```
20
45
 
21
- ### React Library
46
+ ### React Libraries
47
+
48
+ ```js
49
+ // eslint.config.mjs
50
+ import reactConfig from '@djangocfg/eslint-config/react-internal';
22
51
 
23
- ```json
24
- {
25
- "extends": ["@djangocfg/eslint-config/react"]
26
- }
52
+ export default reactConfig;
27
53
  ```
28
54
 
29
- ### Base Config
55
+ ### Base TypeScript
30
56
 
31
- ```json
32
- {
33
- "extends": ["@djangocfg/eslint-config"]
34
- }
57
+ ```js
58
+ // eslint.config.mjs
59
+ import baseConfig from '@djangocfg/eslint-config/base';
60
+
61
+ export default baseConfig;
35
62
  ```
36
63
 
37
- ## Features
64
+ ## Available Configs
65
+
66
+ | Config | Description |
67
+ |--------|-------------|
68
+ | `@djangocfg/eslint-config/base` | Base TypeScript configuration |
69
+ | `@djangocfg/eslint-config/next-js` | Next.js App Router configuration |
70
+ | `@djangocfg/eslint-config/react-internal` | React library configuration |
71
+
72
+ ## Included Plugins
73
+
74
+ - `@eslint/js` - ESLint recommended rules
75
+ - `typescript-eslint` - TypeScript linting
76
+ - `eslint-plugin-react` - React specific rules
77
+ - `eslint-plugin-react-hooks` - Hooks rules
78
+ - `@next/eslint-plugin-next` - Next.js rules
79
+ - `eslint-plugin-turbo` - Turborepo rules
80
+ - `eslint-config-prettier` - Prettier compatibility
81
+
82
+ ## Documentation
83
+
84
+ Full documentation available at [djangocfg.com](https://djangocfg.com)
85
+
86
+ ## Contributing
87
+
88
+ Issues and pull requests are welcome at [GitHub](https://github.com/markolofsen/django-cfg)
89
+
90
+ ## License
38
91
 
39
- - TypeScript support
40
- - React hooks rules
41
- - Import sorting
42
- - Accessibility checks
43
- - Next.js optimizations
92
+ MIT - see [LICENSE](./LICENSE) for details
package/package.json CHANGED
@@ -1,12 +1,33 @@
1
1
  {
2
2
  "name": "@djangocfg/eslint-config",
3
- "version": "1.4.17",
3
+ "version": "1.4.19",
4
+ "description": "Shared ESLint configurations for Next.js, React, and TypeScript projects with best practices and Prettier integration",
5
+ "keywords": [
6
+ "eslint",
7
+ "eslint-config",
8
+ "typescript",
9
+ "react",
10
+ "nextjs",
11
+ "prettier",
12
+ "linting",
13
+ "code-quality",
14
+ "django",
15
+ "turbo"
16
+ ],
4
17
  "author": {
5
18
  "name": "DjangoCFG",
6
19
  "url": "https://djangocfg.com"
7
20
  },
21
+ "homepage": "https://djangocfg.com",
22
+ "repository": {
23
+ "type": "git",
24
+ "url": "https://github.com/markolofsen/django-cfg.git",
25
+ "directory": "packages/eslint-config"
26
+ },
27
+ "bugs": {
28
+ "url": "https://github.com/markolofsen/django-cfg/issues"
29
+ },
8
30
  "license": "MIT",
9
- "description": "Shared ESLint configurations for Unrealon projects",
10
31
  "type": "module",
11
32
  "exports": {
12
33
  "./base": "./base.js",
@@ -30,5 +51,8 @@
30
51
  "globals": "^16.3.0",
31
52
  "typescript": "^5.8.2",
32
53
  "typescript-eslint": "^8.37.0"
54
+ },
55
+ "publishConfig": {
56
+ "access": "public"
33
57
  }
34
58
  }