@kitschpatrol/prettier-config 4.7.6 → 4.7.8

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/package.json +3 -6
  2. package/readme.md +18 -0
package/package.json CHANGED
@@ -1,17 +1,14 @@
1
1
  {
2
2
  "name": "@kitschpatrol/prettier-config",
3
- "version": "4.7.6",
3
+ "version": "4.7.8",
4
4
  "type": "module",
5
5
  "description": "Prettier configuration for @kitschpatrol/shared-config.",
6
6
  "repository": {
7
7
  "type": "git",
8
- "url": "git@github.com:kitschpatrol/shared-config.git",
8
+ "url": "git+https://github.com/kitschpatrol/shared-config/cli.git",
9
9
  "directory": "packages/prettier-config"
10
10
  },
11
- "bugs": {
12
- "url": "https://github.com/kitschpatrol/shared-config/issues",
13
- "email": "eric@ericmika.com"
14
- },
11
+ "bugs": "https://github.com/kitschpatrol/shared-config/issues",
15
12
  "author": {
16
13
  "name": "Eric Mika",
17
14
  "email": "eric@ericmika.com",
package/readme.md CHANGED
@@ -101,6 +101,24 @@ Ruby formatting Expects a global Ruby install >=2.7 via `rbenv` at `~/.rbenv/shi
101
101
 
102
102
  Note: Do _not_ add `plugins: ['prettier-plugin-ruby']` to the per-file scope, it must be global.
103
103
 
104
+ ## Tabs vs. spaces
105
+
106
+ Tabs are unambiguously preferred wherever the file format specification does not mandate spaces.
107
+
108
+ The reluctant exceptions are:
109
+
110
+ ### JSON
111
+
112
+ Despite widely accepted FUD regarding JSON requiring spaces, the [specification](https://www.json.org/json-en.html) indicates otherwise.
113
+
114
+ ### YAML
115
+
116
+ Spaces are required by the [specification](https://yaml.org/spec/1.2.2/#61-indentation-spaces).
117
+
118
+ ### Markdown and MDX
119
+
120
+ Spaces are not technically required, but are specified in alignment with the [Remark project's conclusions](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-tabs#recommendation) and to prevent fragility in YAML frontmatter. _(TODO: Need 4 spaces instead of 2?)_
121
+
104
122
  <!-- license -->
105
123
 
106
124
  ## License