knutkirkhorn / sofic

Check the source files in directories

sofic

Check the source files in directories

Sofic: Source file checker.

Installation

npm install --global sofic

Usage

$ sofic --help

  Usage
    $ sofic <path>

  Examples
    $ sofic C:\Users\knut\dev\sofic
    $ sofic C:\Users\knut\dev

sofic's Issues

Check for `eslint-plugin-ava`

• Check if ava is used
• If so, check if eslint-plugin-ava has been added
  • Check both installed packages and ESLint config

Check for ESLint

Check if eslint is installed before checking ESLint plugins.

VS Code extension

`add` command

Command to setup things for given source code. Examples:

• eslint - using sofic add eslint
• prettier
• gh-actions

Store snippet configs in a snippet directory.

Add GitLab CI check

Check if NPM package

• If the repo has package.json and private is not set.
• Should include files:
  • .npmrc file
  • Type definitions (.d.ts)
  • Type definition tests (.test-d.ts)
• Should not include package-lock.json

Check if code is ESM

• Check if JavaScript repo
• Check if type is set to module
• Check if it has main set
• Check if "exports": "./index.js" and "types": "./index.d.ts" is set
• Check if engines is set

Check for Prettier

Needs to check:

• prettier.config.js file
• installed Prettier in package.json
• @ianvs/prettier-plugin-sort-imports
• ESLint Prettier plugin

Add option to only print directories with errors

Check Node.js Dockerfile

• Check if the Dockerfile is using a Node.js image
• Check if that image is using a LTS version

Fix running without path

Currently if ran using the globally installed version, it will check related to it's own path and not the current path in the terminal.

Check for GitHub Actions workflow

Check if there exists any YAML files inside the relative path .github/workflows

Print if no checks are done for directory

• Show information that no checks are done
• This might mean that it isn't a source code directory

Check for `eslint-plugin-unicorn`

Add way to ignore directories

Maybe use a .soficignore file?

Check for `eslint.config.js`

This is a new config file after the ESLint v9.0.0 release and the .eslintrc / .eslintrc.json files are now deprecated. See https://eslint.org/docs/latest/use/migrate-to-9.0.0#flat-config

Only check for github actions workflow for git repos

Check that CLI is executable

This is related to initial push of sofic: 8abd9ec

• Determine if repo is node CLI
• Check if cli.js is executable

Add fixable errors

• At least for files, it should be easy to fix the error.
• Do this if a --fix flag is provided.
• Print out what has been fixed.
• When running the CLI: print if errors are fixable.

Check for Tailwind Prettier plugin

Check first if tailwind is installed

Only check for `gitattributes` and `gitignore` if directory is a git repo