@sinemacula/coding-standards 1.2.0 → 1.3.0
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 +7 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,11 +3,12 @@
|
|
|
3
3
|
[](https://packagist.org/packages/sinemacula/coding-standards)
|
|
4
4
|
[](https://www.npmjs.com/package/@sinemacula/coding-standards)
|
|
5
5
|
[](https://qlty.sh/gh/sinemacula/projects/coding-standards)
|
|
6
|
+
[](https://qlty.sh/gh/sinemacula/projects/coding-standards)
|
|
6
7
|
[](https://packagist.org/packages/sinemacula/coding-standards)
|
|
7
8
|
|
|
8
9
|
Centralized coding standards, static analysis configurations, and code quality tooling for all Sine Macula repositories.
|
|
9
10
|
|
|
10
|
-
This package ships config files only
|
|
11
|
+
This package ships config files only - no runtime dependencies. Consuming projects install the tools themselves.
|
|
11
12
|
|
|
12
13
|
## Installation
|
|
13
14
|
|
|
@@ -82,7 +83,9 @@ parameters:
|
|
|
82
83
|
|
|
83
84
|
#### Laravel projects
|
|
84
85
|
|
|
85
|
-
|
|
86
|
+
For Laravel projects, also install [`sinemacula/coding-standards-laravel`](https://github.com/sinemacula/coding-standards-laravel)
|
|
87
|
+
and reference its `SineMaculaLaravel` PHPCS standard (which includes this one) in place of `SineMacula`. It
|
|
88
|
+
adds the Laravel-specific sniffs and PHPStan rules; see that package's README for setup.
|
|
86
89
|
|
|
87
90
|
### Biome (JavaScript / TypeScript)
|
|
88
91
|
|
|
@@ -113,13 +116,13 @@ After installing the npm package, extend the shared Biome config from your proje
|
|
|
113
116
|
|
|
114
117
|
### Qlty
|
|
115
118
|
|
|
116
|
-
Reference this repository as a source in your project's `.qlty/qlty.toml
|
|
119
|
+
Reference this repository as a source in your project's `.qlty/qlty.toml`, pinning `tag` to the latest [release](https://github.com/sinemacula/coding-standards/releases):
|
|
117
120
|
|
|
118
121
|
```toml
|
|
119
122
|
[[source]]
|
|
120
123
|
name = "sinemacula"
|
|
121
124
|
repository = "https://github.com/sinemacula/coding-standards"
|
|
122
|
-
tag = "
|
|
125
|
+
tag = "<version>"
|
|
123
126
|
```
|
|
124
127
|
|
|
125
128
|
## What's Included
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sinemacula/coding-standards",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "Centralized coding standards, static analysis configurations, and code quality tooling for all Sine Macula repositories.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "Ben Carey <bdmc@sinemacula.co.uk>",
|