Skip to content

itgalaxy/file-type-lint

Repository files navigation

file-type-lint

NPM version Travis Build Status dependencies Status devDependencies Status

Lint file types based on their content.

Installation

npm i -D file-type-lint

Usage

CLI

file-type-lint .

API

const fileTypeLint = require("file-type-lint");

fileTypeLint({
  files: "**/*",
})
  .then((result) => {
    console.log(result.errored); // If `true` when contain error
    console.log(result.errors); // Array of errors

    return result;
  })
  .catch((error) => {
    throw error;
  });

Roadmap

  • Formatters.
  • Improve error readability.
  • Less sync operation.
  • More tests (100% coverage).
  • Documentation.

Contribution

Feel free to push your code if you agree with publishing under the MIT license.