refactor: simplify build and rename bin to cli (#428)

* refactor: simplify build and rename bin to cli

* chore: remove unnecessary build folder

* chore: disable invalid lint rules

Author: Shinigami

.eslintignore

@@ -3,7 +3,6 @@ node_modules
 # Automatically generated directories
 bin
 dist
-build
 
 # Website directory
 website

.eslintrc.js

@@ -34,6 +34,7 @@ module.exports = {
     'template-curly-spacing': 'error',
     'template-tag-spacing': 'error',
 
+    '@typescript-eslint/adjacent-overload-signatures': 'off',
     '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/no-unsafe-assignment': 'off',
     '@typescript-eslint/no-unsafe-call': 'off',

.gitignore

@@ -66,9 +66,3 @@ test/e2e/reports
 /website/node_modules
 /website/build
 /website/.docusaurus
-
-# Build folder
-build
-
-# Bin folder
-bin

bin/htmlhint

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict'
+
+require('../dist/cli/htmlhint')

build-linux.sh

@@ -2,17 +2,10 @@
 set -x
 
 # Cleanup
-rm -Rf ./build
-rm -Rf ./bin
 rm -Rf ./dist
 
 # Prepare
 npx tsc
 
-# Move bin
-mkdir ./bin
-cp -r ./build/bin/* ./bin/
-mv ./bin/htmlhint.js ./bin/htmlhint
-
 # Build core
 npm run build:rollup

build-windows.bat

@@ -1,17 +1,10 @@
 @echo off
 
 :: Cleanup
-IF EXIST build ( rmdir build /q /s ) ELSE ( echo build folder not present )
-IF EXIST bin ( rmdir bin /q /s ) ELSE ( echo bin folder not present )
 IF EXIST dist ( rmdir dist /q /s ) ELSE ( echo dist folder not present )
 
 :: Prepare
 call npx tsc
 
-:: Move bin
-mkdir bin
-robocopy build\bin bin /s /e
-ren "bin\htmlhint.js" "htmlhint"
-
 :: Build core
 npm run build:rollup

package.json

@@ -21,7 +21,7 @@
     "htmlhint": "./bin/htmlhint"
   },
   "main": "dist/htmlhint.js",
-  "module": "src/core.js",
+  "module": "dist/core/core.js",
   "scripts": {
     "commit": "npx git-cz",
     "prettier": "prettier --write .",

rollup.config.js

@@ -3,7 +3,7 @@ import commonjs from '@rollup/plugin-commonjs'
 import { terser } from 'rollup-plugin-terser'
 
 const config = {
-  input: './build/core/core.js',
+  input: './dist/core/core.js',
   output: {
     file: 'dist/htmlhint.js',
     format: 'umd',

src/bin/formatter.ts renamed to src/cli/formatter.ts

@@ -5,13 +5,14 @@ const defaultFormatter: FormatterCallback = function (
   HTMLHint,
   options
 ) {
-  const nocolor: boolean = !!options.nocolor
+  const nocolor = !!options.nocolor
 
   formatter.on('start', () => {
     console.log('')
   })
 
   formatter.on('config', (event) => {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const configPath = event.configPath!
     console.log('   Config loaded: %s', nocolor ? configPath : configPath.cyan)
     console.log('')

src/bin/formatters/checkstyle.ts renamed to src/cli/formatters/checkstyle.ts

@@ -13,10 +13,10 @@ import type { HTMLHint as IHTMLHint } from '../core/core'
 import type { Hint, Ruleset } from '../core/types'
 import { Formatter } from './formatter'
 
-const HTMLHint: typeof IHTMLHint = require('../dist/htmlhint.js').HTMLHint
+const HTMLHint: typeof IHTMLHint = require('../htmlhint.js').HTMLHint
 const formatter: Formatter = require('./formatter')
 
-const pkg = require('../package.json')
+const pkg = require('../../package.json')
 
 function map(val: string) {
   const objMap: { [name: string]: string | true } = {}
@@ -112,6 +112,7 @@ function listRules() {
 
   for (const id in rules) {
     rule = rules[id]
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     console.log('     %s : %s', rule.id.bold, rule.description)
   }
 }
@@ -428,6 +429,7 @@ function walkPath(
     })
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const walk: any = glob(
     pattern,
     {

src/bin/formatters/compact.ts renamed to src/cli/formatters/compact.ts

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["src/bin"]
+  "exclude": ["src/cli"]
 }

src/bin/formatters/default.ts renamed to src/cli/formatters/default.ts

@@ -6,7 +6,7 @@
     "lib": ["ES2018", "DOM"],
     "moduleResolution": "Node",
     "rootDir": "src",
-    "outDir": "build",
+    "outDir": "dist",
     "strict": true,
     "removeComments": true
   },

src/bin/formatters/html.ts renamed to src/cli/formatters/html.ts

@@ -10,5 +10,5 @@
     "removeComments": true,
     "noEmit": true
   },
-  "exclude": ["node_modules", "bin", "build", "dist", "website"]
+  "exclude": ["node_modules", "bin", "dist", "website"]
 }