aolenevme / lint-fs

Lint File System with Regular Expressions! 📐

Hi! 👋🏻 I’m Alexander Olenev

Senior Frontend Engineer

Website Email Telegram Leetcode LinkedIn

lint-fs's Issues

Fail on Unused Regular Expressions

Description

Currently, the program fails only if it meets an incorrect file path.

The program must fail if any of the regular expressions are unused.

HowTo

The easiest way is to use Map<string, boolean>.

[CHORE] Automate Code Style

Describe the chore
Even though the previous eslint configuration is already pretty heavy, there is space for more changes.

What can be done?

1. Enable most disabled rules from eslint-canonical.
2. Add missing rules from golang-like eslint config.
3. Prevent usage of excessive data types (Date, Set, Map, WeakMap, WeakSet) to use more specific data types such as Object and Array.

Additional context
These changes might be very beneficial. They will commit the project`s code style and force the local mutation principle.

[FEATURE] Hide "Correct Files" section in the output

In the output we have several sections: "Incorrect Files" and "Correct Files". First one is useful and necessary, but second one is redundant. I have 10k+ files in my project, and the output looks overloaded.

Suggestions:

• Hide "Correct Files" in the output by default
• Add a debug flag to display this section when needed

Verbose Mode

Description

Show linted files only in verbose mode. Always show result.

HowTo

Add --verbose CLI options

[CHORE] Improve Infrastructer

Describe the chore

1. Add .nvmrc — and update engines if applicable.
2. Update all libraries.
3. Add dependabot to automate library updates.

Build for the NodeJS

Description

There aren`t reasons to build a binary for the NodeJS users. They can download transpiled JS instead of compiled binary.

HowTo

Use babel or find a different way. Transpile code to the last maintained NodeJS version.

100% Unit Test Coverage

Description

Write missing unit tests.

HowTo

1. Use c8 to collect coverage and native node/assert module.
2. All changes must be displayed in CHANGELOG.md.

Refactoring

Description

The project was unmaintained for pretty long. It is time to fix it!

HowTo

• Write down CODESTYLE.md
• Adapt the code base to the CODESTYLE.md rules.
• Update README.md on how to install lint-fs right now.
• Use npx and npm -g or local installation to run the linter.
• Migrate to canonical.
• Update dependencies and engines. Write down engines in package.json.
• 100% unit tests` coverage. Use c8 for the coverage.
• 100% mutation tests` coverage.

Badges

Description

Add badges to the README.md:

1. Build Status
2. Version
3. License
4. Last commit
5. Unit coverage
6. Stryker coverage
7. Linter
8. Code quality
9. Status Checks

HowTo

1. Adjust GitHub Actions.
2. Generate badges via badges/shields.
3. Organise badges like in prettier.

Npx run

Description

Now one has to call https://github.com/aolenevme/lint-fs/blob/main/npm/run.js to lint a project. Refactor to npx.

HowTo

Just integrate! :))

Community Standards

Description & HowTo

1. Enhance the project with community standards.
2. Add a more correct License?

Version

Description

Add a version of the linter on top of the stdout.

HowTo

Read package.json

Automate Releases

Description

The following things should be automated:

1. git tag creation
2. package.json and package-lock.json version updates.
3. npm publish

HowTo

Find out a good GitHub Action - or write scripts on your own!

Status Checks

Description

Add status checks to github actions.

HowTo

Create github actions which run on every merge request to the master:

1. Run unit tests.
2. Run mutatation tests.
3. Run linters.

Sponsorship

Description

Make an RnD on how to automate sponsorship.

HowTo

1. Inner GitHub features to make both the repository and the whole account profitable.

Replace yaml with json

Description

Replace lint-fs.yaml with lint-fs.json to remove usage of an unsupported js-yaml.

HowTo

1. Delete js-yaml.
2. Use nodejs core library to read and parse lint-fs.json.