@osdlc/prettier-config 0.0.0-stage → 0.2.3
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/CHANGELOG.md +43 -0
- package/LICENSE +21 -0
- package/README.md +59 -2
- package/index.json +16 -0
- package/package.json +34 -3
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to
|
|
6
|
+
[Semantic Versioning](https://semver.org/).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.2.3] - 2026-10-16
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- Renamed from `@sksizer/prettier-config`. No other changes.
|
|
15
|
+
- To move, replace `@sksizer/prettier-config` with `@osdlc/prettier-config` in `devDependencies` and in every
|
|
16
|
+
Prettier `"prettier"` reference.
|
|
17
|
+
|
|
18
|
+
## [0.2.2] - 2026-10-15
|
|
19
|
+
|
|
20
|
+
### Changed
|
|
21
|
+
|
|
22
|
+
- First release made from [sksizer/sdlc](https://github.com/sksizer/sdlc) CI, through npm trusted
|
|
23
|
+
publishing, so the package now carries provenance. The package contents are unchanged.
|
|
24
|
+
|
|
25
|
+
## [0.2.1] - 2026-10-15
|
|
26
|
+
|
|
27
|
+
### Changed
|
|
28
|
+
|
|
29
|
+
- Published to npm from [sksizer/sdlc](https://github.com/sksizer/sdlc), with a LICENSE file
|
|
30
|
+
and a README written for outside readers.
|
|
31
|
+
|
|
32
|
+
## [0.2.0] - 2026-09-06
|
|
33
|
+
|
|
34
|
+
### Changed
|
|
35
|
+
|
|
36
|
+
- **BREAKING:** Markdown is formatted by exactly one owner per flavour, and the format gate matches
|
|
37
|
+
it, so markdown formatting results change for consumers.
|
|
38
|
+
|
|
39
|
+
## [0.1.0] - 2026-09-01
|
|
40
|
+
|
|
41
|
+
### Added
|
|
42
|
+
|
|
43
|
+
- Initial shared Prettier config for the monorepo, with a generated-output ignore list.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 SK Sizer
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,60 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @osdlc/prettier-config
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A shared [Prettier](https://prettier.io) config: no semicolons, single quotes,
|
|
4
|
+
trailing commas everywhere, 100 columns, two-space indent. Markdown is left
|
|
5
|
+
alone (see below).
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install --save-dev @osdlc/prettier-config prettier
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Use
|
|
12
|
+
|
|
13
|
+
Name the package in your Prettier config. In `package.json`:
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
{ "prettier": "@osdlc/prettier-config" }
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Or in a `.prettierrc`:
|
|
20
|
+
|
|
21
|
+
```text
|
|
22
|
+
"@osdlc/prettier-config"
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The quotes are required in `.prettierrc`: it is parsed as YAML, and a bare `@`
|
|
26
|
+
leading a plain scalar is reserved.
|
|
27
|
+
|
|
28
|
+
## Markdown is not formatted
|
|
29
|
+
|
|
30
|
+
The config has exactly one override, and it exists to hand `.md` away rather
|
|
31
|
+
than to style it:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{ "files": "*.md", "options": { "requirePragma": true } }
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Prettier column-pads markdown tables on every pass, which fights a dedicated
|
|
38
|
+
markdown formatter. Prettier has no way to exclude a language from config:
|
|
39
|
+
`overrides` sets options, there is no `ignore` key, and `excludeFiles` only
|
|
40
|
+
drops a file from that override's options. With `requirePragma` set, Prettier
|
|
41
|
+
parses markdown and then declines to reformat any file that lacks a `@format`
|
|
42
|
+
or `@prettier` pragma. A file that adds the pragma opts itself back in.
|
|
43
|
+
|
|
44
|
+
`.mdx` is still Prettier's: `files: "*.md"` does not match it.
|
|
45
|
+
|
|
46
|
+
## Ignore files
|
|
47
|
+
|
|
48
|
+
`.prettierignore` is read from the directory Prettier runs in and does not
|
|
49
|
+
cascade, so each project keeps its own. This package does not ship one.
|
|
50
|
+
|
|
51
|
+
## Source and releases
|
|
52
|
+
|
|
53
|
+
Developed and released in
|
|
54
|
+
[osdlc/osdlc](https://github.com/osdlc/osdlc/tree/main/packages/prettier-config),
|
|
55
|
+
under `packages/prettier-config`. Report issues at
|
|
56
|
+
[osdlc/osdlc/issues](https://github.com/osdlc/osdlc/issues).
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
[MIT](https://github.com/osdlc/osdlc/blob/main/packages/prettier-config/LICENSE)
|
package/index.json
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,37 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdlc/prettier-config",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.2.3",
|
|
4
|
+
"description": "A shared Prettier config: no semicolons, single quotes, trailing commas, 100 columns. Markdown is left alone.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "SK Sizer",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/osdlc/osdlc.git",
|
|
10
|
+
"directory": "packages/prettier-config"
|
|
11
|
+
},
|
|
12
|
+
"homepage": "https://github.com/osdlc/osdlc/tree/main/packages/prettier-config#readme",
|
|
13
|
+
"bugs": "https://github.com/osdlc/osdlc/issues",
|
|
14
|
+
"keywords": [
|
|
15
|
+
"prettier",
|
|
16
|
+
"prettier-config"
|
|
17
|
+
],
|
|
18
|
+
"publishConfig": {
|
|
19
|
+
"access": "public"
|
|
20
|
+
},
|
|
21
|
+
"main": "index.json",
|
|
22
|
+
"files": [
|
|
23
|
+
"index.json",
|
|
24
|
+
"README.md",
|
|
25
|
+
"CHANGELOG.md",
|
|
26
|
+
"LICENSE"
|
|
27
|
+
],
|
|
28
|
+
"devDependencies": {
|
|
29
|
+
"oxlint": "^1.65.0",
|
|
30
|
+
"prettier": "3.9.6"
|
|
31
|
+
},
|
|
32
|
+
"scripts": {
|
|
33
|
+
"format": "prettier --write .",
|
|
34
|
+
"format:check": "prettier --check .",
|
|
35
|
+
"lint": "oxlint . --no-error-on-unmatched-pattern"
|
|
36
|
+
}
|
|
6
37
|
}
|