|
| 1 | +/** |
| 2 | + * Taken & simplified from https://github.com/sindresorhus/conf/blob/main/source/index.ts |
| 3 | + * |
| 4 | + * MIT License |
| 5 | + * |
| 6 | + * Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com) |
| 7 | + * |
| 8 | + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: |
| 9 | + * |
| 10 | + * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. |
| 11 | + * |
| 12 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 13 | + */ |
| 14 | + |
| 15 | +import assert from 'node:assert' |
| 16 | +import fs from 'node:fs' |
| 17 | +import path from 'node:path' |
| 18 | + |
| 19 | +import { envPaths } from './envPaths.js' |
| 20 | + |
| 21 | +const createPlainObject = <T = Record<string, unknown>>(): T => Object.create(null) |
| 22 | + |
| 23 | +const checkValueType = (key: string, value: unknown): void => { |
| 24 | + const nonJsonTypes = new Set(['undefined', 'symbol', 'function']) |
| 25 | + |
| 26 | + const type = typeof value |
| 27 | + |
| 28 | + if (nonJsonTypes.has(type)) { |
| 29 | + throw new TypeError( |
| 30 | + `Setting a value of type \`${type}\` for key \`${key}\` is not allowed as it's not supported by JSON`, |
| 31 | + ) |
| 32 | + } |
| 33 | +} |
| 34 | + |
| 35 | +export class Conf<T extends Record<string, any> = Record<string, unknown>> |
| 36 | + implements Iterable<[keyof T, T[keyof T]]> |
| 37 | +{ |
| 38 | + readonly #options: Readonly<Partial<Options>> |
| 39 | + private readonly _deserialize: Deserialize<T> = (value) => JSON.parse(value) |
| 40 | + private readonly _serialize: Serialize<T> = (value) => JSON.stringify(value, undefined, '\t') |
| 41 | + |
| 42 | + readonly events: EventTarget |
| 43 | + |
| 44 | + readonly path: string |
| 45 | + |
| 46 | + constructor() { |
| 47 | + const options: Partial<Options> = { |
| 48 | + configFileMode: 0o666, |
| 49 | + configName: 'config', |
| 50 | + fileExtension: 'json', |
| 51 | + projectSuffix: 'nodejs', |
| 52 | + } |
| 53 | + |
| 54 | + const cwd = envPaths('payload', { suffix: options.projectSuffix }).config |
| 55 | + |
| 56 | + this.#options = options |
| 57 | + |
| 58 | + this.events = new EventTarget() |
| 59 | + |
| 60 | + const fileExtension = options.fileExtension ? `.${options.fileExtension}` : '' |
| 61 | + this.path = path.resolve(cwd, `${options.configName ?? 'config'}${fileExtension}`) |
| 62 | + |
| 63 | + const fileStore = this.store |
| 64 | + const store = Object.assign(createPlainObject(), fileStore) |
| 65 | + |
| 66 | + try { |
| 67 | + assert.deepEqual(fileStore, store) |
| 68 | + } catch { |
| 69 | + this.store = store |
| 70 | + } |
| 71 | + } |
| 72 | + |
| 73 | + private _ensureDirectory(): void { |
| 74 | + // Ensure the directory exists as it could have been deleted in the meantime. |
| 75 | + fs.mkdirSync(path.dirname(this.path), { recursive: true }) |
| 76 | + } |
| 77 | + |
| 78 | + private _write(value: T): void { |
| 79 | + const data: Uint8Array | string = this._serialize(value) |
| 80 | + |
| 81 | + fs.writeFileSync(this.path, data, { mode: this.#options.configFileMode }) |
| 82 | + } |
| 83 | + |
| 84 | + *[Symbol.iterator](): IterableIterator<[keyof T, T[keyof T]]> { |
| 85 | + for (const [key, value] of Object.entries(this.store)) { |
| 86 | + yield [key, value] |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + /** |
| 91 | + Delete an item. |
| 92 | +
|
| 93 | + @param key - The key of the item to delete. |
| 94 | + */ |
| 95 | + delete(key: string): void { |
| 96 | + const { store } = this |
| 97 | + delete store[key] |
| 98 | + |
| 99 | + this.store = store |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + Get an item. |
| 104 | +
|
| 105 | + @param key - The key of the item to get. |
| 106 | + */ |
| 107 | + get<Key extends keyof T>(key: Key): T[Key] { |
| 108 | + const { store } = this |
| 109 | + return store[key] |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + Set an item or multiple items at once. |
| 114 | +
|
| 115 | + @param key - You can use [dot-notation](https://github.com/sindresorhus/dot-prop) in a key to access nested properties. Or a hashmap of items to set at once. |
| 116 | + @param value - Must be JSON serializable. Trying to set the type `undefined`, `function`, or `symbol` will result in a `TypeError`. |
| 117 | + */ |
| 118 | + set<Key extends keyof T>(key: string, value?: T[Key] | unknown): void { |
| 119 | + if (typeof key !== 'string' && typeof key !== 'object') { |
| 120 | + throw new TypeError( |
| 121 | + `Expected \`key\` to be of type \`string\` or \`object\`, got ${typeof key}`, |
| 122 | + ) |
| 123 | + } |
| 124 | + |
| 125 | + if (typeof key !== 'object' && value === undefined) { |
| 126 | + throw new TypeError('Use `delete()` to clear values') |
| 127 | + } |
| 128 | + |
| 129 | + const { store } = this |
| 130 | + |
| 131 | + const set = (key: string, value?: T | T[Key] | unknown): void => { |
| 132 | + checkValueType(key, value) |
| 133 | + store[key as Key] = value as T[Key] |
| 134 | + } |
| 135 | + |
| 136 | + if (typeof key === 'object') { |
| 137 | + const object = key |
| 138 | + for (const [key, value] of Object.entries(object)) { |
| 139 | + set(key, value) |
| 140 | + } |
| 141 | + } else { |
| 142 | + set(key, value) |
| 143 | + } |
| 144 | + |
| 145 | + this.store = store |
| 146 | + } |
| 147 | + get size(): number { |
| 148 | + return Object.keys(this.store).length |
| 149 | + } |
| 150 | + get store(): T { |
| 151 | + try { |
| 152 | + const dataString = fs.readFileSync(this.path, 'utf8') |
| 153 | + const deserializedData = this._deserialize(dataString) |
| 154 | + return Object.assign(createPlainObject(), deserializedData) |
| 155 | + } catch (error: unknown) { |
| 156 | + if ((error as any)?.code === 'ENOENT') { |
| 157 | + this._ensureDirectory() |
| 158 | + return createPlainObject() |
| 159 | + } |
| 160 | + |
| 161 | + throw error |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + set store(value: T) { |
| 166 | + this._ensureDirectory() |
| 167 | + |
| 168 | + this._write(value) |
| 169 | + |
| 170 | + this.events.dispatchEvent(new Event('change')) |
| 171 | + } |
| 172 | +} |
| 173 | + |
| 174 | +export type Options = { |
| 175 | + /** |
| 176 | + The config is cleared if reading the config file causes a `SyntaxError`. This is a good behavior for unimportant data, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing. |
| 177 | +
|
| 178 | + @default false |
| 179 | + */ |
| 180 | + clearInvalidConfig?: boolean |
| 181 | + |
| 182 | + /** |
| 183 | + The [mode](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) that will be used for the config file. |
| 184 | +
|
| 185 | + You would usually not need this, but it could be useful if you want to restrict the permissions of the config file. Setting a permission such as `0o600` would result in a config file that can only be accessed by the user running the program. |
| 186 | +
|
| 187 | + Note that setting restrictive permissions can cause problems if different users need to read the file. A common problem is a user running your tool with and without `sudo` and then not being able to access the config the second time. |
| 188 | +
|
| 189 | + @default 0o666 |
| 190 | + */ |
| 191 | + readonly configFileMode?: number |
| 192 | + |
| 193 | + /** |
| 194 | + Name of the config file (without extension). |
| 195 | +
|
| 196 | + Useful if you need multiple config files for your app or module. For example, different config files between two major versions. |
| 197 | +
|
| 198 | + @default 'config' |
| 199 | + */ |
| 200 | + configName?: string |
| 201 | + |
| 202 | + /** |
| 203 | + Extension of the config file. |
| 204 | +
|
| 205 | + You would usually not need this, but could be useful if you want to interact with a file with a custom file extension that can be associated with your app. These might be simple save/export/preference files that are intended to be shareable or saved outside of the app. |
| 206 | +
|
| 207 | + @default 'json' |
| 208 | + */ |
| 209 | + fileExtension?: string |
| 210 | + |
| 211 | + readonly projectSuffix?: string |
| 212 | +} |
| 213 | + |
| 214 | +export type Serialize<T> = (value: T) => string |
| 215 | +export type Deserialize<T> = (text: string) => T |
0 commit comments