@ivuorinen/config-checker 1.1.12 → 2.1.1

package/LICENSE.md

@@ -2,8 +2,20 @@ 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:
+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 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.
+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

@@ -29,22 +29,22 @@ For commitlint-config you can find the usage in the [commitlint-config postinsta
 Here's a snippet from the file:
 
 ```js
-const process = require('process')
-const checkConfig = require('@ivuorinen/config-checker')
-const foundConfig = checkConfig('commitlint')
+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)
+  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              |
@@ -126,12 +126,12 @@ This project is licensed under the MIT License - see the [LICENSE.md][license-li
 
 [changelog-link]: ./CHANGELOG.md
 [contributing-link]: https://github.com/ivuorinen/.github/blob/main/CONTRIBUTING.md
-[issue-link]: https://github.com/ivuorinen/base-configs/issues
-[license-badge]: https://img.shields.io/github/license/ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399
+[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/base-configs/pulls
+[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/base-configs
-[commitlint-postinstall-link]: https://github.com/ivuorinen/base-configs/blob/main/packages/commitlint-config/scripts/postinstall.js
+[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

@@ -1,10 +1,10 @@
 /* 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')
+const fs = require("node:fs");
+const path = require("node:path");
 // noinspection NpmUsedModulesInstalled
-const process = require('node:process')
-const configurationPaths = require('./configuration-paths')
+const process = require("node:process");
+const configurationPaths = require("./configuration-paths");
 
 /**
  * Checks for the existence of a configuration file.
@@ -12,21 +12,21 @@ const configurationPaths = require('./configuration-paths')
  * @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
+const configChecker = (moduleName, pathPrefix = "") => {
+  let searchPath = process.env.INIT_CWD;
   if (pathPrefix.length > 0) {
-    searchPath = pathPrefix
+    searchPath = pathPrefix;
   }
 
-  const allFiles = configurationPaths(moduleName)
+  const allFiles = configurationPaths(moduleName);
 
   if (process.env.DEBUG) {
-    const filesWithPath = allFiles.map(file => path.join(searchPath, file))
-    console.log(filesWithPath)
+    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)))
-}
+  return allFiles.filter((file) => fs.existsSync(path.join(searchPath, file)));
+};
 
-module.exports = configChecker
+module.exports = configChecker;

package/lib/configuration-paths.js

@@ -1,11 +1,11 @@
-const path = require('node:path')
+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 configurationPaths = (moduleName) => {
   const filesPlain = [
     moduleName,
     `${moduleName}rc`,
@@ -22,14 +22,14 @@ const configurationPaths = moduleName => {
     `${moduleName}.config.js`,
     `${moduleName}.config.ts`,
     `${moduleName}.config.mjs`,
-    `${moduleName}.config.cjs`
-  ]
+    `${moduleName}.config.cjs`,
+  ];
 
-  const filesDot = filesPlain.map(file => `.${file}`)
-  const bothFiles = filesPlain.concat(filesDot)
-  const filesInConfig = bothFiles.map(file => path.join('.config', file))
+  const filesDot = filesPlain.map((file) => `.${file}`);
+  const bothFiles = filesPlain.concat(filesDot);
+  const filesInConfig = bothFiles.map((file) => path.join(".config", file));
 
-  return bothFiles.concat(filesInConfig)
-}
+  return bothFiles.concat(filesInConfig);
+};
 
-module.exports = configurationPaths
+module.exports = configurationPaths;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ivuorinen/config-checker",
-  "version": "1.1.12",
+  "version": "2.1.1",
   "description": "Checks the commonly used configuration locations for configuration files",
   "keywords": [
     "check-config",
@@ -15,7 +15,7 @@
     "name": "Ismo Vuorinen",
     "url": "https://github.com/ivuorinen"
   },
-  "homepage": "https://github.com/ivuorinen/base-configs/tree/main/packages/config-checker#readme",
+  "homepage": "https://github.com/ivuorinen/config-checker#readme",
   "license": "MIT",
   "main": "lib/config-checker.js",
   "directories": {
@@ -30,14 +30,24 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ivuorinen/base-configs.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"
+    "generate-table": "node ./helpers/generate-md-table.js",
+    "semantic-release": "semantic-release"
   },
   "bugs": {
-    "url": "https://github.com/ivuorinen/base-configs/issues"
+    "url": "https://github.com/ivuorinen/config-checker/issues"
   },
-  "gitHead": "569c783f0bca1bd0b1be78c7b4d09297ee9934eb"
+  "packageManager": "yarn@4.12.0",
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "semantic-release": "^25.0.2"
+  }
 }