@coko/lint 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.1.0](https://gitlab.coko.foundation/cokoapps/lint/compare/v2.0.1...v2.1.0) (2024-02-26)
+
+
+### Features
+
+* add cli command for lint checks ([c912ce1](https://gitlab.coko.foundation/cokoapps/lint/commit/c912ce1343ccf92668dfa197f01bd6a9f82043a9))
+
+
+### Bug Fixes
+
+* add bin entry to package.json for cli ([3ecb2f5](https://gitlab.coko.foundation/cokoapps/lint/commit/3ecb2f5aa35039ff4e06d54782e3b49a9316ff48))
+
 ### [2.0.1](https://gitlab.coko.foundation/cokoapps/lint/compare/v2.0.0...v2.0.1) (2023-02-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coko/lint",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Linter configurations and dependencies for coko's projects",
   "keywords": [
     "lint",
@@ -14,6 +14,9 @@
   "license": "MIT",
   "author": "Yannis Barlas",
   "main": "src/index.js",
+  "bin": {
+    "coko-lint": "./src/cli.js"
+  },
   "files": [
     "src"
   ],
@@ -34,6 +37,7 @@
     "@babel/preset-react": "^7.16.7",
     "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.2.1",
+    "commander": "^11.1.0",
     "commitizen": "^4.2.4",
     "conventional-commit-types": "^3.0.0",
     "cz-conventional-changelog": "^3.3.0",

package/src/cli.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-console */
+
+const { program } = require('commander')
+const { execSync } = require('child_process')
+
+const pkg = require('../package.json')
+
+const ESLINT = 'ESLint'
+const STYLELINT = 'Stylelint'
+const PRETTIER = 'Prettier'
+const filler = '>>>> '
+
+// #region actions
+const printVersion = () => {
+  console.log(`Coko lint version: ${program.version()}`)
+}
+
+const runCommand = (name, command, isSubprocess) => {
+  console.log(`\n${filler}Running ${name}...`)
+
+  try {
+    execSync(command, { stdio: 'inherit' })
+  } catch (error) {
+    console.error(`Error running ${name}: ${error.message}`)
+
+    if (isSubprocess) {
+      throw new Error()
+    } else {
+      process.exit(1)
+    }
+  }
+}
+
+const runSubprocess = (fn, name, skip) => {
+  try {
+    if (skip) {
+      console.log(`\n${filler}Skipping ${name}...`)
+      return
+    }
+
+    fn(true)
+  } catch {
+    throw new Error()
+  }
+}
+
+const runESLint = isSubprocess => {
+  const command = `npx eslint ${process.cwd()}`
+  runCommand(ESLINT, command, isSubprocess)
+}
+
+const runStylelint = isSubprocess => {
+  const command = `npx stylelint "${process.cwd()}/**/*.js"`
+  runCommand(STYLELINT, command, isSubprocess)
+}
+
+const runPrettier = isSubprocess => {
+  const command = `npx prettier --check ${process.cwd()}`
+  runCommand(PRETTIER, command, isSubprocess)
+}
+
+const runAll = (options = {}) => {
+  let hasErrors = false
+
+  const processes = [
+    [runESLint, ESLINT, options.skipEslint],
+    [runStylelint, STYLELINT, options.skipStylelint],
+    [runPrettier, PRETTIER, options.skipPrettier],
+  ]
+
+  /* eslint-disable-next-line no-restricted-syntax */
+  for (const process of processes) {
+    try {
+      runSubprocess(...process)
+    } catch {
+      hasErrors = true
+    }
+  }
+
+  if (hasErrors) {
+    console.error('\nError: Linting checks did not pass!')
+    process.exit(1)
+  }
+
+  console.log(`\nLinting checks successfully passed`)
+}
+// #endregion actions
+
+program
+  .name('coko-lint')
+  .version(pkg.version)
+  .description("Coko's cli tool for running linters")
+
+program
+  .command('eslint')
+  .description('Run eslint command')
+  .action(() => {
+    printVersion()
+    runESLint()
+  })
+
+program
+  .command('stylelint')
+  .description('Run stylelint command')
+  .action(() => {
+    printVersion()
+    runStylelint()
+  })
+
+program
+  .command('prettier')
+  .description('Run prettier command')
+  .action(() => {
+    printVersion()
+    runPrettier()
+  })
+
+program
+  .command('run')
+  .description('Run all commands (eslint, stylelint, prettier)')
+  .option('--skip-eslint', 'Skip eslint')
+  .option('--skip-stylelint', 'Skip stylelint')
+  .option('--skip-prettier', 'Skip prettier')
+  .action(options => {
+    printVersion()
+    runAll(options)
+  })
+
+program.parse(process.argv)