@qvaroo/configs 1.0.0 → 1.0.1
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.
- package/README.md +15 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @qvaroo/configs
|
|
2
2
|
|
|
3
|
-
> **Centralized
|
|
3
|
+
> **Centralized Qvaroo coding standards for TypeScript frontend projects.**
|
|
4
4
|
>
|
|
5
5
|
> This library acts as the **single source of truth** for all coding, architecture, and tooling standards. All rule violations **fail CI/CD pipelines**, removing human discretion from standards enforcement.
|
|
6
6
|
|
|
7
|
-
[](https://www.npmjs.com/package/@qvaroo/configs)
|
|
8
8
|
[](https://opensource.org/licenses/MIT)
|
|
9
9
|
|
|
10
10
|
---
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
## 📦 Installation
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
-
npm install --save-dev @
|
|
15
|
+
npm install --save-dev @qvaroo/configs
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
### Peer Dependencies
|
|
@@ -34,7 +34,7 @@ Create `.eslintrc.js` in your project root:
|
|
|
34
34
|
**For React/Next.js projects:**
|
|
35
35
|
```javascript
|
|
36
36
|
module.exports = {
|
|
37
|
-
extends: ['./node_modules/@
|
|
37
|
+
extends: ['./node_modules/@qvaroo/configs/eslint/react.js'],
|
|
38
38
|
parserOptions: {
|
|
39
39
|
project: './tsconfig.json',
|
|
40
40
|
tsconfigRootDir: __dirname,
|
|
@@ -45,7 +45,7 @@ module.exports = {
|
|
|
45
45
|
**For Node.js/Backend projects:**
|
|
46
46
|
```javascript
|
|
47
47
|
module.exports = {
|
|
48
|
-
extends: ['./node_modules/@
|
|
48
|
+
extends: ['./node_modules/@qvaroo/configs/eslint/node.js'],
|
|
49
49
|
parserOptions: {
|
|
50
50
|
project: './tsconfig.json',
|
|
51
51
|
tsconfigRootDir: __dirname,
|
|
@@ -56,7 +56,7 @@ module.exports = {
|
|
|
56
56
|
**For base TypeScript projects:**
|
|
57
57
|
```javascript
|
|
58
58
|
module.exports = {
|
|
59
|
-
extends: ['./node_modules/@
|
|
59
|
+
extends: ['./node_modules/@qvaroo/configs/eslint/index.js'],
|
|
60
60
|
parserOptions: {
|
|
61
61
|
project: './tsconfig.json',
|
|
62
62
|
tsconfigRootDir: __dirname,
|
|
@@ -69,7 +69,7 @@ module.exports = {
|
|
|
69
69
|
Create `prettier.config.js`:
|
|
70
70
|
|
|
71
71
|
```javascript
|
|
72
|
-
module.exports = require('@
|
|
72
|
+
module.exports = require('@qvaroo/configs/prettier');
|
|
73
73
|
```
|
|
74
74
|
|
|
75
75
|
### 3. TypeScript Configuration
|
|
@@ -79,7 +79,7 @@ Create `tsconfig.json`:
|
|
|
79
79
|
**For React projects:**
|
|
80
80
|
```json
|
|
81
81
|
{
|
|
82
|
-
"extends": "@
|
|
82
|
+
"extends": "@qvaroo/configs/typescript/react",
|
|
83
83
|
"compilerOptions": {
|
|
84
84
|
"baseUrl": "."
|
|
85
85
|
},
|
|
@@ -91,7 +91,7 @@ Create `tsconfig.json`:
|
|
|
91
91
|
**For Node.js projects:**
|
|
92
92
|
```json
|
|
93
93
|
{
|
|
94
|
-
"extends": "@
|
|
94
|
+
"extends": "@qvaroo/configs/typescript/node",
|
|
95
95
|
"compilerOptions": {
|
|
96
96
|
"baseUrl": "."
|
|
97
97
|
},
|
|
@@ -309,7 +309,7 @@ Override specific rules in your project's `.eslintrc.js`:
|
|
|
309
309
|
|
|
310
310
|
```javascript
|
|
311
311
|
module.exports = {
|
|
312
|
-
extends: ['./node_modules/@
|
|
312
|
+
extends: ['./node_modules/@qvaroo/configs/eslint/react.js'],
|
|
313
313
|
rules: {
|
|
314
314
|
// Relax for specific project needs
|
|
315
315
|
'max-lines-per-function': ['error', { max: 60 }],
|
|
@@ -330,12 +330,12 @@ Variable names are checked for spelling. Add project-specific terms:
|
|
|
330
330
|
|
|
331
331
|
```javascript
|
|
332
332
|
module.exports = {
|
|
333
|
-
extends: ['./node_modules/@
|
|
333
|
+
extends: ['./node_modules/@qvaroo/configs/eslint'],
|
|
334
334
|
rules: {
|
|
335
335
|
'spellcheck/spell-checker': ['warn', {
|
|
336
336
|
skipWords: [
|
|
337
337
|
// Add your domain terms
|
|
338
|
-
'
|
|
338
|
+
'qvaroo',
|
|
339
339
|
'oauth',
|
|
340
340
|
'saml',
|
|
341
341
|
],
|
|
@@ -363,7 +363,7 @@ module.exports = {
|
|
|
363
363
|
## 📁 Package Contents
|
|
364
364
|
|
|
365
365
|
```
|
|
366
|
-
@
|
|
366
|
+
@qvaroo/configs/
|
|
367
367
|
├── eslint/
|
|
368
368
|
│ ├── index.js # Base ESLint config
|
|
369
369
|
│ ├── react.js # React/Next.js config
|
|
@@ -388,4 +388,4 @@ module.exports = {
|
|
|
388
388
|
|
|
389
389
|
## 📄 License
|
|
390
390
|
|
|
391
|
-
MIT ©
|
|
391
|
+
MIT © Qvaroo DevOps Team
|
package/package.json
CHANGED