@nedcloarbr/biome-config 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/LICENSE ADDED
@@ -0,0 +1,8 @@
1
+ The MIT License (MIT)
2
+ Copyright © 2024 Miguel Alexandre Uhlein < NedcloarBR >
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5
+
6
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7
+
8
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,63 @@
1
+ <div align="center">
2
+
3
+ ![BiomeJS Logo](https://raw.githubusercontent.com/biomejs/resources/main/svg/slogan-light-transparent.svg)
4
+
5
+ # @nedcloarbr/biome-config
6
+
7
+ **[BiomeJS](https://biomejs.dev/) Configuration used by [NedcloarBR](https://github.com/NedcloarBR) in their projects**
8
+
9
+ [![GitHub](https://img.shields.io/github/license/NedcloarBR/biome-config)](https://github.com/NedcloarBR/biome-config/blob/main/LICENSE)
10
+ [![npm](https://img.shields.io/npm/v/@nedcloarbr/biome-config?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@nedcloarbr/biome-config)
11
+
12
+ </div>
13
+
14
+ **Table of Contents**
15
+
16
+ - [Description](#description)
17
+ - [Installation](#installation)
18
+ - [Usage](#usage)
19
+ - [To-Do](#to-do)
20
+
21
+ ## Description
22
+
23
+ Configuring a linter and formatter, such as `BiomeJS`, is crucial for maintaining consistent, readable, and error-free code. Linters ensure uniform coding standards and early error detection, saving debugging time. Formatters automate code structuring, enhancing readability and maintenance. These tools increase productivity by allowing developers to focus on critical tasks. They also enforce quality standards, creating a professional development environment. In CI/CD workflows, they ensure code adherence to quality standards, preserving codebase integrity.
24
+
25
+ The package includes configuration for [`NestJS`](https://nestjs.com/)
26
+
27
+ ## Installation
28
+
29
+ You can use the following command to install this package.
30
+
31
+ ```sh
32
+ npm install --save-dev --save-exact @biomejs/biome @nedcloarbr/biome-config
33
+
34
+ yarn add --dev --exact @biomejs/biome @nedcloarbr/biome-config
35
+
36
+ pnpm install --save-dev --save-exact @biomejs/biome @nedcloarbr/biome-config
37
+
38
+ bun add --dev --exact @biomejs/biome @nedcloarbr/biome-config
39
+ ```
40
+
41
+ ## Usage
42
+
43
+ ### [`NestJS`](https://nestjs.com/)
44
+
45
+ ```jsonc
46
+ // biome.json
47
+ {
48
+ "extends": ["@nedcloarbr/biome-config/nestjs"]
49
+ // ...
50
+ }
51
+ ```
52
+
53
+ ## To-Do
54
+
55
+ Add support for other types of projects
56
+
57
+ - [ ] ReactJS
58
+ - [ ] Vanilla
59
+ - [ ] Vite
60
+ - [ ] NextJS
61
+ - [ ] NodeJS
62
+ - [ ] Vanilla
63
+ - [ ] TypeScript
package/nestjs.json ADDED
@@ -0,0 +1,82 @@
1
+ {
2
+ "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
3
+ "organizeImports": {
4
+ "enabled": true
5
+ },
6
+ "formatter": {
7
+ "enabled": true,
8
+ "indentWidth": 2,
9
+ "indentStyle": "tab",
10
+ "lineEnding": "lf",
11
+ "lineWidth": 120
12
+ },
13
+ "javascript": {
14
+ "parser": {
15
+ "unsafeParameterDecoratorsEnabled": true
16
+ },
17
+ "formatter": {
18
+ "enabled": true,
19
+ "semicolons": "always",
20
+ "quoteStyle": "double",
21
+ "quoteProperties": "asNeeded",
22
+ "trailingComma": "all"
23
+ }
24
+ },
25
+ "linter": {
26
+ "enabled": true,
27
+ "rules": {
28
+ "complexity": {
29
+ "noEmptyTypeParameters": "error",
30
+ "noExcessiveCognitiveComplexity": "error",
31
+ "noForEach": "error",
32
+ "noUselessCatch": "error",
33
+ "noUselessConstructor": "error",
34
+ "noUselessEmptyExport": "error",
35
+ "noUselessSwitchCase": "error",
36
+ "noVoid": "off",
37
+ "useArrowFunction": "error",
38
+ "useLiteralKeys": "off",
39
+ "useOptionalChain": "error",
40
+ "useRegexLiterals": "error",
41
+ "useSimplifiedLogicExpression": "error"
42
+ },
43
+ "correctness": {
44
+ "noConstAssign": "error",
45
+ "noConstantCondition": "error",
46
+ "noEmptyCharacterClassInRegex": "error",
47
+ "noEmptyPattern": "error",
48
+ "noGlobalObjectCalls": "error",
49
+ "noInnerDeclarations": "off",
50
+ "noInvalidConstructorSuper": "error",
51
+ "noInvalidNewBuiltin": "error",
52
+ "noSwitchDeclarations": "off"
53
+ },
54
+ "nursery": {
55
+ "noDuplicateJsonKeys": "error"
56
+ },
57
+ "style": {
58
+ "noDefaultExport": "error",
59
+ "noVar": "error",
60
+ "noUselessElse": "error",
61
+ "noNonNullAssertion": "off",
62
+ "useAsConstAssertion": "warn",
63
+ "useConst": "error",
64
+ "useExportType": "info",
65
+ "useImportType": "info",
66
+ "useShorthandArrayType": "error",
67
+ "useSingleVarDeclarator": "error"
68
+ },
69
+ "suspicious": {
70
+ "noApproximativeNumericConstant": "error",
71
+ "noCatchAssign": "error",
72
+ "noConfusingVoidType": "error",
73
+ "noDoubleEquals": "error",
74
+ "noDuplicateCase": "error",
75
+ "noDuplicateParameters": "error",
76
+ "noEmptyBlockStatements": "error",
77
+ "noEmptyInterface": "error",
78
+ "noExplicitAny": "error"
79
+ }
80
+ }
81
+ }
82
+ }
package/package.json ADDED
@@ -0,0 +1,42 @@
1
+ {
2
+ "name": "@nedcloarbr/biome-config",
3
+ "version": "1.0.1",
4
+ "description": "BiomeJS Configuration used by NedcloarBR in their projects",
5
+ "license": "MIT",
6
+ "publishConfig": {
7
+ "registry": "https://registry.npmjs.org",
8
+ "access": "public"
9
+ },
10
+ "author": {
11
+ "name": "Miguel Alexandre Uhlein <NedcloarBR>",
12
+ "email": "nedcloar1@hotmail.com",
13
+ "url": "https://github.com/NedcloarBR"
14
+ },
15
+ "repository": {
16
+ "type": "git",
17
+ "url": "git+https://github.com/NedcloarBR/biome-config.git"
18
+ },
19
+ "bugs": {
20
+ "url": "https://github.com/NedcloarBR/biome-config/issues"
21
+ },
22
+ "homepage": "https://github.com/NedcloarBR/biome-config#readme",
23
+ "keywords": [
24
+ "BiomeJS",
25
+ "NestJS",
26
+ "linter",
27
+ "formatter"
28
+ ],
29
+ "exports": {
30
+ "./nestjs": "./nestjs.json"
31
+ },
32
+ "files": [
33
+ "nestjs.json"
34
+ ],
35
+ "packageManager": "yarn@4.3.1",
36
+ "scripts": {
37
+ "release": "release-it"
38
+ },
39
+ "devDependencies": {
40
+ "release-it": "^17.4.1"
41
+ }
42
+ }