-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Implement remembering last torrent ID for the specified directory. Setting `rememberLastTorrent: true` makes `torrent-clean` save last torrent ID value to `lastTorrent` property inside config file. `lastTorrent` value is used when `--torrent` argument is not set. - Make `--torrent` and `torrentId` optional. Throw error when `torrentId` cannot be received from `lastTorrent` property - Add some spacing in CLI output - Return "Parsed TORRENT_NAME" CLI output - Add `nyc` to collect coverage - Update dependencies
- Loading branch information
1 parent
86f16e2
commit d9b6fd8
Showing
15 changed files
with
1,897 additions
and
388 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,3 +6,7 @@ node_modules/ | |
|
|
||
| # Optional eslint cache | ||
| .eslintcache | ||
|
|
||
| # nyc test coverage | ||
| .nyc_output | ||
| coverage | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| const path = require('path') | ||
| const fs = require('fs') | ||
| const { cosmiconfig } = require('cosmiconfig') | ||
| const YAML = require('yaml') | ||
|
|
||
| const { merge } = require('./helpers') | ||
|
|
||
| /** | ||
| * @typedef {import('cosmiconfig/dist/types').CosmiconfigResult} CosmiconfigResult | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {object} TorrentCleanConfig | ||
| * @property {string[]} [ignore] Globs to ignore files | ||
| * @property {boolean} [rememberLastTorrent] Save last specified torrent ID to config | ||
| * @property {string} [lastTorrent] Last specified torrent ID | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {object} LoadConfigResult | ||
| * @property {TorrentCleanConfig} config Merged config | ||
| * @property {CosmiconfigResult} [searchFromCosmiconfigResult] `cosmiconfig` | ||
| * search result inside `searchFrom` | ||
| */ | ||
|
|
||
| /** @typedef {'json' | 'yaml'} FileType */ | ||
|
|
||
| const MODULE_NAME = 'torrent-clean' | ||
|
|
||
| const COSMICONFIG_SEARCH_PLACES = [ | ||
| `.${MODULE_NAME}rc`, | ||
| `.${MODULE_NAME}rc.json`, | ||
| `.${MODULE_NAME}rc.yaml`, | ||
| `.${MODULE_NAME}rc.yml`, | ||
| ] | ||
| /** Default ignore patterns */ | ||
| const IGNORE_GLOBS = ['~uTorrentPartFile*', `.${MODULE_NAME}rc*`] | ||
|
|
||
| /** | ||
| * Loads and merges configs starting from `searchFrom` directory | ||
| * | ||
| * @param {string} searchFrom Config search start directory | ||
| * @param {TorrentCleanConfig} [customConfig] Config with highest priority | ||
| * @returns {Promise<LoadConfigResult>} | ||
| */ | ||
| exports.loadConfig = async function loadConfig(searchFrom, customConfig) { | ||
| const explorer = cosmiconfig(MODULE_NAME, { | ||
| searchPlaces: COSMICONFIG_SEARCH_PLACES, | ||
| }) | ||
|
|
||
| /** @type {CosmiconfigResult} */ | ||
| let searchFromCosmiconfigResult | ||
|
|
||
| /** @type {CosmiconfigResult[]} */ | ||
| const results = [] | ||
| /** @type {CosmiconfigResult} */ | ||
| let result = await explorer.search(searchFrom) | ||
|
|
||
| // Remember `startFrom` search config result | ||
| if (result && path.dirname(result.filepath) === searchFrom) { | ||
| searchFromCosmiconfigResult = result | ||
| } | ||
|
|
||
| // Collect all configs up to root directory | ||
| while (result) { | ||
| results.push(result) | ||
|
|
||
| const configDirName = path.dirname(result.filepath) | ||
| const parentDir = path.resolve(configDirName, '..') | ||
|
|
||
| result = await explorer.search(parentDir) | ||
| } | ||
|
|
||
| /** @type {TorrentCleanConfig} */ | ||
| const mergedConfig = [ | ||
| // The closer config to `searchFrom` directory is, the higher its priority | ||
| ...results.map((result) => result.config).reverse(), | ||
| customConfig, | ||
| ] | ||
| .filter(Boolean) | ||
| .reduce(merge, {}) | ||
|
|
||
| if (mergedConfig.ignore) { | ||
| mergedConfig.ignore = [...IGNORE_GLOBS, ...mergedConfig.ignore] | ||
| } else { | ||
| mergedConfig.ignore = IGNORE_GLOBS | ||
| } | ||
|
|
||
| return { | ||
| config: mergedConfig, | ||
| ...(searchFromCosmiconfigResult && { searchFromCosmiconfigResult }), | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Detects file type by file path | ||
| * | ||
| * @param {string} filepath | ||
| * @returns {FileType} | ||
| */ | ||
| function getFileType(filepath) { | ||
| const extension = path.extname(filepath) | ||
|
|
||
| if (extension === '.json') { | ||
| return 'json' | ||
| } else if (['.yaml', '.yml'].includes(extension)) { | ||
| return 'yaml' | ||
| } else { | ||
| const content = fs.readFileSync(filepath).toString() | ||
|
|
||
| try { | ||
| JSON.parse(content) | ||
| return 'json' | ||
| } catch { | ||
| return 'yaml' | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Saves config | ||
| * | ||
| * @param {object} params | ||
| * @param {TorrentCleanConfig} params.config | ||
| * @param {string} params.saveDirPath | ||
| * @param {string} [params.existingConfigPath] Path to existing config file | ||
| */ | ||
| exports.saveConfig = function saveConfig({ | ||
| config, | ||
| saveDirPath, | ||
| existingConfigPath, | ||
| }) { | ||
| /** @type {FileType} */ | ||
| const fileType = existingConfigPath ? getFileType(existingConfigPath) : 'yaml' | ||
|
|
||
| const fileContent = | ||
| fileType === 'json' | ||
| ? JSON.stringify(config, null, 2) | ||
| : YAML.stringify(config) | ||
|
|
||
| const filename = | ||
| existingConfigPath || path.join(saveDirPath, `.${MODULE_NAME}rc`) | ||
|
|
||
| fs.writeFileSync(filename, fileContent) | ||
| } |
Oops, something went wrong.