@roughen/config 0.2.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/LICENSE +21 -0
- package/README.md +23 -0
- package/docs.d.ts +3 -0
- package/docs.js +1 -0
- package/index.d.ts +5 -0
- package/index.js +4 -0
- package/marketing.d.ts +3 -0
- package/marketing.js +2 -0
- package/package.json +42 -0
- package/recommended.d.ts +3 -0
- package/recommended.js +1 -0
- package/strict.d.ts +3 -0
- package/strict.js +1 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Upforge
|
|
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
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @roughen/config
|
|
2
|
+
|
|
3
|
+
Presets for `@roughen/core`: recommended, strict, marketing, and docs.
|
|
4
|
+
|
|
5
|
+
```js
|
|
6
|
+
import { marketing } from '@roughen/config';
|
|
7
|
+
import { lint } from '@roughen/core';
|
|
8
|
+
const result = lint(text, { ...marketing, format: 'md' });
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
`marketing` sets `register: 'marketing'`, so list saturation is measured against human marketing pages instead of articles. Human landing pages use comma series at about the article threshold as a matter of course, so the article baseline flagged half of them. The marketing threshold is the 95th percentile of the fit split of [marketing-001](../../research/corpus/reports/marketing-001.md). Those pages aren't rated yet, so treat it as provisional. Every other rule keeps its article baseline, because marketing-001 found they fire on human marketing at close to their article rates.
|
|
12
|
+
|
|
13
|
+
A project adds its own house rules on top, including absolute bans:
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
// roughen.config.mjs
|
|
17
|
+
export default {
|
|
18
|
+
extends: ['marketing'],
|
|
19
|
+
voice: { bannedCharacters: ['—'], bannedPatterns: [{ pattern: '\\bgenuinely\\b', flags: 'i' }] },
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
MIT.
|
package/docs.d.ts
ADDED
package/docs.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export default Object.freeze({ rules: Object.freeze({ 'artifact/smart-quotes': 'off', 'artifact/ellipsis-char': 'off' }) });
|
package/index.d.ts
ADDED
package/index.js
ADDED
package/marketing.d.ts
ADDED
package/marketing.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@roughen/config",
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Shared house-style presets for Roughen.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"roughen",
|
|
8
|
+
"config",
|
|
9
|
+
"presets",
|
|
10
|
+
"prose",
|
|
11
|
+
"linter",
|
|
12
|
+
"house-style"
|
|
13
|
+
],
|
|
14
|
+
"publishConfig": {
|
|
15
|
+
"access": "public"
|
|
16
|
+
},
|
|
17
|
+
"type": "module",
|
|
18
|
+
"exports": {
|
|
19
|
+
".": "./index.js",
|
|
20
|
+
"./recommended": "./recommended.js",
|
|
21
|
+
"./strict": "./strict.js",
|
|
22
|
+
"./marketing": "./marketing.js",
|
|
23
|
+
"./docs": "./docs.js"
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"*.js",
|
|
27
|
+
"*.d.ts",
|
|
28
|
+
"LICENSE",
|
|
29
|
+
"README.md"
|
|
30
|
+
],
|
|
31
|
+
"types": "./index.d.ts",
|
|
32
|
+
"sideEffects": false,
|
|
33
|
+
"peerDependencies": {
|
|
34
|
+
"@roughen/core": "^0.3.0"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"@roughen/core": "0.3.0"
|
|
38
|
+
},
|
|
39
|
+
"scripts": {
|
|
40
|
+
"build": "node --check index.js"
|
|
41
|
+
}
|
|
42
|
+
}
|
package/recommended.d.ts
ADDED
package/recommended.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export default Object.freeze({ rules: Object.freeze({}) });
|
package/strict.d.ts
ADDED
package/strict.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export default Object.freeze({ rules: Object.freeze({ 'artifact/zero-width': 'error', 'artifact/soft-hyphen': 'error', 'preamble/opener': 'error', 'preamble/meta': 'error', 'preamble/closer': 'error' }) });
|