-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
toggle.ts
109 lines (97 loc) · 2.83 KB
/
toggle.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/**
* @file Toggle
* @module toggle-pkg-type/toggle
*/
import type { Command } from '#src/types'
import * as mlly from '@flex-development/mlly'
import pathe from '@flex-development/pathe'
import type { PackageJson } from '@flex-development/pkg-types'
import { isString, type Nilable, type Nullable } from '@flex-development/tutils'
import fs from 'node:fs'
/**
* Enable or disable the [`type`][1] field in a `package.json` file.
*
* The field is disabled by changing the field name to `#type`. The field value
* will not be modified.
*
* Command Manifest:
*
* - `NIL` (`null`, `undefined`): Disable `type` if enabled, re-enable otherwise
* - `off`: Disable `type` field
* - `on`: Re-enable `type` field
*
* This is a **no-op** under any of the following conditions:
*
* - A `package.json` file is not found
* - The `type` field is not defined in the located manifest
* - The `#type` field is not defined in the located manifest (i.e. the `type`
* field was not previously disabled)
*
* [1]: https://nodejs.org/api/packages.html#type
*
* @see {@linkcode Command}
* @see {@linkcode mlly.ModuleId}
*
* @example
* toggle()
* @example
* toggle('off')
* @example
* toggle('on', new URL('.'))
* @example
* toggle('on', process.env.npm_package_json)
*
* @param {Nilable<Command>?} [command=null] - Toggle command
* @param {mlly.ModuleId?} [id='.'] - Module id of package directory or manifest
* @return {void} Nothing when complete
*/
function toggle(
command: Nilable<Command> = null,
id: mlly.ModuleId = '.'
): void {
const { pathname } = mlly.toURL(id)
/**
* Absolute path to directory containing `package.json` file.
*
* @const {string} directory
*/
const directory: string = pathname.endsWith('package.json')
? pathe.dirname(pathname)
: pathname
/**
* Initial `package.json` data.
*
* @var {Nullable<PackageJson>} pkg
*/
let pkg: Nullable<PackageJson> = mlly.readPackageJson(directory)
// do nothing if package.json was not found, package type is not defined, or
// if package type was not previously disabled
if (!pkg || !isString(pkg.type ?? pkg['#type'])) return void pkg
/**
* Character used to disable `type` field.
*
* @const {string} HASH
*/
const HASH: string = '#'
// toggle package type
pkg = Object.keys(pkg).reduce<PackageJson>((acc, key) => {
const [, type, pre = ''] = new RegExp(`^((${HASH}?)type)$`).exec(key) ?? []
if (type) {
key = command
? `${command === 'off' ? HASH : ''}type`
: pre
? type.replace(new RegExp('^' + pre), '')
: HASH + type
acc[key] = pkg![type]!
} else {
acc[key] = pkg![key]!
}
return acc
}, {})
// rewrite package.json
return void fs.writeFileSync(
pathe.join(directory, 'package.json'),
JSON.stringify(pkg, null, 2) + '\n'
)
}
export default toggle