@ivuorinen/config-checker 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ismo Vuorinen
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -0,0 +1,139 @@
+# `@ivuorinen/config-checker` <!-- omit in toc -->
+
+[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
+
+Check for existence of common configuration files in usually used locations.
+
+## Installation
+
+Install `this package` as a _`dependency`_:
+
+```sh
+# npm
+npm install @ivuorinen/config-checker --save
+
+# Yarn
+yarn add @ivuorinen/config-checker
+```
+
+## Usage
+
+This package is intended to be used in lifecycle events of other packages.
+
+Configuration packages located in this repository use this tool to check for existence of configuration files, and if they exist, they will not create new ones.
+
+### Real world example
+
+For commitlint-config you can find the usage in the [commitlint-config postinstall.cjs][commitlint-postinstall-link] file.
+
+Here's a snippet from the file:
+
+```js
+const process = require("process");
+const checkConfig = require("@ivuorinen/config-checker");
+const foundConfig = checkConfig("commitlint");
+
+if (foundConfig.length > 0) {
+  console.log("commitlint-config: Found existing commitlint config file, skipping creation.");
+  console.log(
+    "commitlint-config: If you want to create a new config file, please remove the existing one.",
+  );
+  console.log(`commitlint-config: Found config files at: ${foundConfig.join(", ")}`);
+  process.exit(0);
+}
+```
+
+### Locations scanned
+
+| Searched configuration files        |
+| ----------------------------------- |
+| `[module name]`                     |
+| `[module name]`rc                   |
+| `[module name]`rc.json              |
+| `[module name]`rc.yaml              |
+| `[module name]`rc.yml               |
+| `[module name]`rc.js                |
+| `[module name]`rc.ts                |
+| `[module name]`rc.mjs               |
+| `[module name]`rc.cjs               |
+| `[module name]`.jsonc               |
+| `[module name]`.yaml                |
+| `[module name]`.json                |
+| `[module name]`.config.js           |
+| `[module name]`.config.ts           |
+| `[module name]`.config.mjs          |
+| `[module name]`.config.cjs          |
+| .`[module name]`                    |
+| .`[module name]`rc                  |
+| .`[module name]`rc.json             |
+| .`[module name]`rc.yaml             |
+| .`[module name]`rc.yml              |
+| .`[module name]`rc.js               |
+| .`[module name]`rc.ts               |
+| .`[module name]`rc.mjs              |
+| .`[module name]`rc.cjs              |
+| .`[module name]`.jsonc              |
+| .`[module name]`.yaml               |
+| .`[module name]`.json               |
+| .`[module name]`.config.js          |
+| .`[module name]`.config.ts          |
+| .`[module name]`.config.mjs         |
+| .`[module name]`.config.cjs         |
+| .config/`[module name]`             |
+| .config/`[module name]`rc           |
+| .config/`[module name]`rc.json      |
+| .config/`[module name]`rc.yaml      |
+| .config/`[module name]`rc.yml       |
+| .config/`[module name]`rc.js        |
+| .config/`[module name]`rc.ts        |
+| .config/`[module name]`rc.mjs       |
+| .config/`[module name]`rc.cjs       |
+| .config/`[module name]`.jsonc       |
+| .config/`[module name]`.yaml        |
+| .config/`[module name]`.json        |
+| .config/`[module name]`.config.js   |
+| .config/`[module name]`.config.ts   |
+| .config/`[module name]`.config.mjs  |
+| .config/`[module name]`.config.cjs  |
+| .config/.`[module name]`            |
+| .config/.`[module name]`rc          |
+| .config/.`[module name]`rc.json     |
+| .config/.`[module name]`rc.yaml     |
+| .config/.`[module name]`rc.yml      |
+| .config/.`[module name]`rc.js       |
+| .config/.`[module name]`rc.ts       |
+| .config/.`[module name]`rc.mjs      |
+| .config/.`[module name]`rc.cjs      |
+| .config/.`[module name]`.jsonc      |
+| .config/.`[module name]`.yaml       |
+| .config/.`[module name]`.json       |
+| .config/.`[module name]`.config.js  |
+| .config/.`[module name]`.config.ts  |
+| .config/.`[module name]`.config.mjs |
+| .config/.`[module name]`.config.cjs |
+
+This list has been generated using `npm run generate-table`.
+
+## Contributing
+
+If you are interested in helping contribute, please take a look at our [contribution guidelines][contributing-link] and open an [issue][issue-link] or [pull request][pull-request-link].
+
+## Changelog
+
+See [CHANGELOG][changelog-link] for a human-readable history of changes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md][license-link] file for details.
+
+[changelog-link]: ./CHANGELOG.md
+[contributing-link]: https://github.com/ivuorinen/.github/blob/main/CONTRIBUTING.md
+[issue-link]: https://github.com/ivuorinen/config-checker/issues
+[license-badge]: https://img.shields.io/github/license/ivuorinen/config-checker?style=flat-square&labelColor=292a44&color=663399
+[license-link]: ./LICENSE.md
+[npm-badge]: https://img.shields.io/npm/v/@ivuorinen/config-checker?style=flat-square&labelColor=292a44&color=663399
+[npm-link]: https://www.npmjs.com/package/@ivuorinen/config-checker
+[pull-request-link]: https://github.com/ivuorinen/config-checker/pulls
+[style-badge]: https://img.shields.io/badge/code_style-ivuorinen%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square
+[style-link]: https://github.com/ivuorinen/config-checker
+[commitlint-postinstall-link]: https://github.com/ivuorinen/base-configs-commitlint/scripts/postinstall.js

package/lib/config-checker.js

@@ -0,0 +1,32 @@
+/* eslint no-console: "off", n/no-process-exit: "off" -- CLI app that gives users feedback */
+
+const fs = require('node:fs')
+const path = require('node:path')
+// noinspection NpmUsedModulesInstalled
+const process = require('node:process')
+const configurationPaths = require('./configuration-paths')
+
+/**
+ * Checks for the existence of a configuration file.
+ * @param {string} moduleName The name of the module to check for.
+ * @param {string} pathPrefix The prefix to add to the path.
+ * @returns {string[]} - The paths to the configuration files.
+ */
+const configChecker = (moduleName, pathPrefix = '') => {
+  let searchPath = process.env.INIT_CWD
+  if (pathPrefix.length > 0) {
+    searchPath = pathPrefix
+  }
+
+  const allFiles = configurationPaths(moduleName)
+
+  if (process.env.DEBUG) {
+    const filesWithPath = allFiles.map(file => path.join(searchPath, file))
+    console.log(filesWithPath)
+  }
+
+  // Look for config files in defined search path, and return found.
+  return allFiles.filter(file => fs.existsSync(path.join(searchPath, file)))
+}
+
+module.exports = configChecker

package/lib/configuration-paths.js

@@ -0,0 +1,35 @@
+const path = require('node:path')
+
+/**
+ * Returns an array of configuration paths.
+ * @param {string} moduleName The name of the module to check for.
+ * @returns {string[]} - The paths to the configuration files.
+ */
+const configurationPaths = moduleName => {
+  const filesPlain = [
+    moduleName,
+    `${moduleName}rc`,
+    `${moduleName}rc.json`,
+    `${moduleName}rc.yaml`,
+    `${moduleName}rc.yml`,
+    `${moduleName}rc.js`,
+    `${moduleName}rc.ts`,
+    `${moduleName}rc.mjs`,
+    `${moduleName}rc.cjs`,
+    `${moduleName}.jsonc`,
+    `${moduleName}.yaml`,
+    `${moduleName}.json`,
+    `${moduleName}.config.js`,
+    `${moduleName}.config.ts`,
+    `${moduleName}.config.mjs`,
+    `${moduleName}.config.cjs`
+  ]
+
+  const filesDot = filesPlain.map(file => `.${file}`)
+  const bothFiles = filesPlain.concat(filesDot)
+  const filesInConfig = bothFiles.map(file => path.join('.config', file))
+
+  return bothFiles.concat(filesInConfig)
+}
+
+module.exports = configurationPaths

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@ivuorinen/config-checker",
+  "version": "1.0.0",
+  "description": "Checks the commonly used configuration locations for configuration files",
+  "keywords": [
+    "check-config",
+    "config",
+    "ivuorinen",
+    "config-checker",
+    "cosmicconfig",
+    "rcfile",
+    "rcfiles"
+  ],
+  "author": {
+    "name": "Ismo Vuorinen",
+    "url": "https://github.com/ivuorinen"
+  },
+  "homepage": "https://github.com/ivuorinen/config-checker#readme",
+  "license": "MIT",
+  "main": "lib/config-checker.js",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ivuorinen/config-checker.git"
+  },
+  "scripts": {
+    "test": "node ./__tests__/config-checker.test.js",
+    "generate-table": "node ./helpers/generate-md-table.js",
+    "eslint:fix": "eslint '**/*.{js,tsx,ts,mjs,cjs}' --fix",
+    "eslint:report": "eslint '**/*.{js,tsx,ts,mjs,cjs}'",
+    "markdownlint:fix": "markdownlint '**/*.md' --fix",
+    "markdownlint:report": "markdownlint '**/*.md'",
+    "prettier:fix": "prettier '**/*.{js,tsx,ts,json,mjs,cjs}' --write",
+    "prettier:report": "prettier '**/*.{js,tsx,ts,json,mjs,cjs}' --check"
+  },
+  "bugs": {
+    "url": "https://github.com/ivuorinen/config-checker/issues"
+  },
+  "devDependencies": {
+    "@ivuorinen/eslint-config": "^0.5.13",
+    "@ivuorinen/markdownlint-config": "^0.3.16",
+    "@ivuorinen/prettier-config": "^0.3.12",
+    "@ivuorinen/semantic-release-config": "^0.3.18"
+  }
+}