add no-restricted-syntax to prevent class uses

.eslintrc.json

@@ -139,6 +139,13 @@
     "max-statements-per-line": "off",
     "no-console": "error",
     "no-inline-comments": "off",
+    "no-restricted-syntax": [
+      "error",
+      {
+        "message": "Avoid using Class, just use good old unit-testable functions :)",
+        "selector": "ClassDeclaration"
+      }
+    ],
     "object-curly-spacing": [
       "error",
       "always"

README.md

@@ -68,7 +68,7 @@ If file already exists, use `--force` to overwrite it.
 - [ ] check last tag, suggest to tag if last one is old
 - [ ] extends unit tests to src/files (remove `c8 ignore start` temporary exclusions)
 - [ ] prepare a json schema for .repo-checker.json
-- [ ] check vitest config file
+- [ ] try to avoid using class in this project and remove `eslint-disable-next-line no-restricted-syntax`
 
 ## Benchmarks
 

src/constants.ts

@@ -9,6 +9,7 @@ export const dataFileName = '.repo-checker.json'
 export const repoCheckerPath = path.join(__dirname, '..')
 export const templatePath = path.join(repoCheckerPath, 'templates')
 
+// eslint-disable-next-line no-restricted-syntax
 export class ProjectData {
 
   /**

src/file.ts

@@ -5,6 +5,7 @@ import { fileExists, getFileSizeInKo, join, messageToCode, readFileInFolder, rea
 
 const defaultAmount = 99
 
+// eslint-disable-next-line no-restricted-syntax
 export class FileBase {
 
   public passed: string[] = []

src/files/dependency-cruiser.ts

@@ -1,5 +1,6 @@
 import { FileBase } from '../file'
 
+// eslint-disable-next-line no-restricted-syntax
 export class DependencyCruiserFile extends FileBase {
   public async start (): Promise<void> {
     const isUsingDepCruiser = this.test(this.data.isUsingDependencyCruiser, 'use dependency cruiser', true)

src/files/editor-config.ts

@@ -1,5 +1,6 @@
 import { FileBase } from '../file'
 
+// eslint-disable-next-line no-restricted-syntax
 export class EditorConfigFile extends FileBase {
   public async start (): Promise<void> {
     const hasFile = await this.checkFileExists('.editorconfig')

src/files/eslint.file.ts

@@ -5,6 +5,7 @@ import { log } from '../logger'
 import { objectToJson, readFileInFolder } from '../utils'
 import { recommendedVueRules, specificRepoCheckerRules, type EslintConfigRules, type EslintRcJsonFile } from './eslint.model'
 
+// eslint-disable-next-line no-restricted-syntax
 export class EsLintFile extends FileBase {
 
   private checkExtends () {

src/files/gh-workflow.ts

@@ -1,6 +1,7 @@
 import { FileBase } from '../file'
 
 /* c8 ignore start */
+// eslint-disable-next-line no-restricted-syntax
 export class GithubWorkflowFile extends FileBase {
 
   private checkPnpm (): void {

src/files/git.ts

@@ -1,5 +1,6 @@
 import { FileBase } from '../file'
 
+// eslint-disable-next-line no-restricted-syntax
 export class GitFile extends FileBase {
   public async start (): Promise<void> {
     this.test(!this.data.hasMainBranch, 'avoid "main" branch reference, use master instead & git bclean', true)

src/files/license.ts

@@ -1,6 +1,7 @@
 import { FileBase } from '../file'
 
 /* c8 ignore start */
+// eslint-disable-next-line no-restricted-syntax
 export class LicenseFile extends FileBase {
   public async start (): Promise<void> {
     const hasFile = await this.checkFileExists('LICENSE')

src/files/npmrc.file.ts

@@ -1,5 +1,6 @@
 import { FileBase } from '../file'
 
+// eslint-disable-next-line no-restricted-syntax
 export class NpmRcFile extends FileBase {
 
   private checkPrePost () {

src/files/nvmrc.ts

@@ -1,6 +1,7 @@
 import { FileBase } from '../file'
 
 /* c8 ignore start */
+// eslint-disable-next-line no-restricted-syntax
 export class NvmrcFile extends FileBase {
   public async start (): Promise<void> {
     const hasFile = await this.checkFileExists('.nvmrc')

src/files/nycrc.ts

@@ -1,6 +1,7 @@
 import { FileBase } from '../file'
 import { log } from '../logger'
 
+// eslint-disable-next-line no-restricted-syntax
 export class NycRcFile extends FileBase {
 
   private async getConfigFileName (): Promise<string> {

src/files/package.file.ts

@@ -5,6 +5,7 @@ import { FileBase } from '../file'
 import { log } from '../logger'
 import { findInFolder, join } from '../utils'
 
+// eslint-disable-next-line no-restricted-syntax
 export class PackageJsonFile extends FileBase {
 
   // eslint-disable-next-line max-statements

src/files/readme.ts

@@ -7,6 +7,7 @@ import { FileBase } from '../file'
 import { log } from '../logger'
 import { fileExists, join, readFile } from '../utils'
 
+// eslint-disable-next-line no-restricted-syntax
 class Thanks {
   public markdown = ''
 
@@ -16,6 +17,7 @@ class Thanks {
   }
 }
 
+// eslint-disable-next-line no-restricted-syntax
 class Badge {
   public markdown = ''
 
@@ -33,6 +35,7 @@ const deprecatedBadges = [
 ]
 
 /* c8 ignore start */
+// eslint-disable-next-line no-restricted-syntax
 export class ReadmeFile extends FileBase {
   private checkMarkdown (): void {
     let hasNoCrLf = this.shouldContains('no CRLF Windows carriage return', /\r/u, 0, false, 'prefer Unix LF', true)

src/files/renovate.ts

@@ -1,6 +1,7 @@
 import { FileBase } from '../file'
 
 /* c8 ignore start */
+// eslint-disable-next-line no-restricted-syntax
 export class RenovateFile extends FileBase {
   public async start (): Promise<void> {
     const hasFile = await this.checkFileExists('renovate.json', true)

src/files/repo-checker.ts

@@ -2,6 +2,7 @@ import { dataFileName } from '../constants'
 import { FileBase } from '../file'
 import { deleteFile, join, jsToJson, readFileInFolder, writeFile } from '../utils'
 
+// eslint-disable-next-line no-restricted-syntax
 export class RepoCheckerConfigFile extends FileBase {
   public async start (): Promise<void> {
     await this.migrateOldConfig('.repo-checker.js')

src/files/tailwind.ts

@@ -1,5 +1,6 @@
 import { FileBase } from '../file'
 
+// eslint-disable-next-line no-restricted-syntax
 export class TailwindFile extends FileBase {
   public async start (): Promise<void> {
     if (!this.data.isUsingTailwind) return

src/files/travis.ts

@@ -1,6 +1,7 @@
 import { FileBase } from '../file'
 
 /* c8 ignore start */
+// eslint-disable-next-line no-restricted-syntax
 export class TravisFile extends FileBase {
   public async start (): Promise<void> {
     const hasFile = await this.fileExists('.travis.yml')

src/files/ts-config.ts

@@ -33,6 +33,7 @@ interface TsConfigJsonFile {
   include: string[]
 }
 
+// eslint-disable-next-line no-restricted-syntax
 export class TsConfigFile extends FileBase {
 
   private fileContentObject: TsConfigJsonFile | undefined

src/logger.ts

@@ -1,5 +1,6 @@
 import { bgBlue, black, Logger } from 'shuutils'
 
+// eslint-disable-next-line no-restricted-syntax
 class ExtendedLogger extends Logger {
   public fix (...stuff: readonly string[]): void {
     const items = Array.from(stuff)

tests/__snapshots__/check.test.ts.snap

@@ -228,7 +228,7 @@ exports[`check C data/tsProject 1`] = `
   "warnings": [
     "use-dependency-cruiser",
     "eslintrc-json-could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "eslintrc-json-current-eslintrc-json-has-only-1-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "eslintrc-json-current-eslintrc-json-has-only-1-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
     "has-a-npmrc-file",
     "package-json-main-file-maximum-size-is-specified-in-data-file-ex-max-size-ko-100",
     "package-json-could-have-a-schema-declaration-like-schema-https-json-schemastore-org-package-43m30m-fixable-39m49m",
@@ -333,7 +333,7 @@ exports[`check E data folders and not throw 1`] = `
   "warnings": [
     "use-dependency-cruiser",
     "eslintrc-json-could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "eslintrc-json-current-eslintrc-json-has-only-1-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "eslintrc-json-current-eslintrc-json-has-only-1-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
     "has-a-npmrc-file",
     "package-json-main-file-maximum-size-is-specified-in-data-file-ex-max-size-ko-100",
     "package-json-could-have-a-schema-declaration-like-schema-https-json-schemastore-org-package-43m30m-fixable-39m49m",

tests/file.test.ts

@@ -12,6 +12,7 @@ const missingFilepath = join(repoCheckerPath, missingFilename)
 const fakeContent = 'zorglub'
 
 it('file A simple validator', async () => {
+  // eslint-disable-next-line no-restricted-syntax
   class MyFile extends FileBase {
     public async start (): Promise<void> {
       await writeFile(missingFilepath, 'Foobar content')
@@ -38,6 +39,7 @@ it('file A simple validator', async () => {
 })
 
 it('file B validator with fix', async () => {
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFix extends FileBase {
     public async start (): Promise<void> {
       await this.checkFileExists(existingFilename)
@@ -55,6 +57,7 @@ it('file B validator with fix', async () => {
 })
 
 it('file C validator with fix & force, overwrite a problematic file with template', async () => {
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFixForce extends FileBase {
     public async start (): Promise<void> {
       await this.inspectFile(existingFilename)
@@ -73,6 +76,7 @@ it('file C validator with fix & force, overwrite a problematic file with templat
 
 it('file D validator with fix & force, update a problematic file on the go', async () => {
   let originalContent = ''
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFixForce extends FileBase {
     public async start (): Promise<void> {
       await this.inspectFile(existingFilename)
@@ -90,6 +94,7 @@ it('file D validator with fix & force, update a problematic file on the go', asy
 
 it('file E validator without force cannot fix a problematic file on the go', async () => {
   let originalContent = ''
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFixForce extends FileBase {
     public async start (): Promise<void> {
       await this.inspectFile(existingFilename)
@@ -106,6 +111,7 @@ it('file E validator without force cannot fix a problematic file on the go', asy
 })
 
 it('file F validator with fix cannot fix if the template require data that is missing', async () => {
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFix extends FileBase {
     public async start (): Promise<void> {
       await this.checkFileExists('template-example.json')
@@ -118,6 +124,7 @@ it('file F validator with fix cannot fix if the template require data that is mi
 })
 
 it('file G validator can detect a missing schema', async () => {
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFix extends FileBase {
     public async start (): Promise<void> {
       await sleep(1)
@@ -132,6 +139,7 @@ it('file G validator can detect a missing schema', async () => {
 })
 
 it('file H validator can detect an existing schema', async () => {
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFix extends FileBase {
     public async start (): Promise<void> {
       await sleep(1)
@@ -150,6 +158,7 @@ it('file H validator can detect an existing schema', async () => {
 })
 
 it('file I validator can fix a missing schema', async () => {
+  // eslint-disable-next-line no-restricted-syntax
   class MyFileFix extends FileBase {
     public async start (): Promise<void> {
       await sleep(1)

tests/files/__snapshots__/eslint.test.ts.snap

@@ -90,7 +90,7 @@ exports[`eslint B config file empty 1`] = `
     "could-have-hardcore-rules-extend-hardcore",
     "could-have-eslint-recommended-rules-extend-eslint-recommended",
     "could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "current-eslintrc-json-has-only-16-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "current-eslintrc-json-has-only-16-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
   ],
 }
 `;
@@ -142,7 +142,7 @@ exports[`eslint C config file empty for ts project 1`] = `
     "could-have-hardcore-rules-extend-hardcore",
     "could-have-eslint-recommended-rules-extend-eslint-recommended",
     "could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "current-eslintrc-json-has-only-0-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "current-eslintrc-json-has-only-0-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
     "could-have-hardcore-typescript-rules-extend-hardcore-ts",
   ],
 }
@@ -196,7 +196,7 @@ exports[`eslint D config file empty for vue ts project 1`] = `
     "could-have-hardcore-rules-extend-hardcore",
     "could-have-eslint-recommended-rules-extend-eslint-recommended",
     "could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "current-eslintrc-json-has-only-0-of-the-72-custom-rules-in-repo-checker-eslintrc-json",
+    "current-eslintrc-json-has-only-0-of-the-73-custom-rules-in-repo-checker-eslintrc-json",
     "could-have-hardcore-typescript-rules-extend-hardcore-ts",
   ],
 }
@@ -249,7 +249,7 @@ exports[`eslint E config file empty for tailwind project 1`] = `
     "could-have-hardcore-rules-extend-hardcore",
     "could-have-eslint-recommended-rules-extend-eslint-recommended",
     "could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "current-eslintrc-json-has-only-16-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "current-eslintrc-json-has-only-16-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
   ],
 }
 `;
@@ -309,7 +309,7 @@ exports[`eslint F config partial file for js project 1`] = `
   "warnings": [
     "could-have-hardcore-rules-extend-hardcore",
     "could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "current-eslintrc-json-has-only-16-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "current-eslintrc-json-has-only-16-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
   ],
 }
 `;
@@ -368,7 +368,7 @@ exports[`eslint G config partial file for ts project 1`] = `
   "warnings": [
     "could-have-hardcore-rules-extend-hardcore",
     "could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "current-eslintrc-json-has-only-0-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "current-eslintrc-json-has-only-0-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
     "could-have-hardcore-typescript-rules-extend-hardcore-ts",
   ],
 }
@@ -440,7 +440,7 @@ exports[`eslint H config partial file for vue ts project 1`] = `
   "warnings": [
     "could-have-hardcore-rules-extend-hardcore",
     "could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "current-eslintrc-json-has-only-0-of-the-72-custom-rules-in-repo-checker-eslintrc-json",
+    "current-eslintrc-json-has-only-0-of-the-73-custom-rules-in-repo-checker-eslintrc-json",
     "could-have-hardcore-typescript-rules-extend-hardcore-ts",
   ],
 }
@@ -578,7 +578,7 @@ exports[`eslint J config file with no rules 1`] = `
   ],
   "warnings": [
     "eslintrc-json-could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "eslintrc-json-current-eslintrc-json-has-only-16-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "eslintrc-json-current-eslintrc-json-has-only-16-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
   ],
 }
 `;
@@ -654,7 +654,7 @@ exports[`eslint K config file with just rules (no override) 1`] = `
   ],
   "warnings": [
     "eslintrc-json-could-have-unicorn-rules-extend-plugin-unicorn-all",
-    "eslintrc-json-current-eslintrc-json-has-only-17-of-the-65-custom-rules-in-repo-checker-eslintrc-json",
+    "eslintrc-json-current-eslintrc-json-has-only-17-of-the-66-custom-rules-in-repo-checker-eslintrc-json",
   ],
 }
 `;
@@ -878,6 +878,13 @@ exports[`eslint M fix rules in overrides 1`] = `
         "max-statements-per-line": "off",
         "no-console": "error",
         "no-inline-comments": "off",
+        "no-restricted-syntax": [
+          "error",
+          {
+            "message": "Avoid using Class, just use good old unit-testable functions :)",
+            "selector": "ClassDeclaration"
+          }
+        ],
         "object-curly-spacing": [
           "error",
           "always"