https://github.com/bbenoist/node-tools

Have you ever forget to export the content of a new source file into the index.ts file of it's parent directory? Not anymore!
https://github.com/bbenoist/node-tools

eslint export index lint linter typescript

Last synced: 18 days ago
JSON representation

Have you ever forget to export the content of a new source file into the index.ts file of it's parent directory? Not anymore!

• Host: GitHub
• URL: https://github.com/bbenoist/node-tools
• Owner: bbenoist
• License: mit
• Created: 2021-03-27T18:10:30.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-04-27T18:48:46.000Z (almost 4 years ago)
• Last Synced: 2024-05-04T05:02:45.548Z (10 months ago)
• Topics: eslint, export, index, lint, linter, typescript
• Language: TypeScript
• Homepage:
• Size: 429 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lint-ts-index

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/bbenoist/lint-ts-index?label=Version&logo=git&sort=semver)](https://github.com/bbenoist/lint-ts-index/releases)

[![License](https://img.shields.io/github/license/bbenoist/lint-ts-index?label=License&logo=github)](https://raw.githubusercontent.com/bbenoist/lint-ts-index/master/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/bbenoist/lint-ts-index?label=Issues&logo=github)](https://github.com/bbenoist/lint-ts-index/issues)

[![CI / CD](https://github.com/bbenoist/lint-ts-index/actions/workflows/ci-cd.yml/badge.svg?branch=master)](https://github.com/bbenoist/lint-ts-index/actions/workflows/ci-cd.yml)

[![npm](https://img.shields.io/npm/dt/@lint-ts-index/core?label=core&logo=npm)](https://npmjs.com/package/core)

[![npm](https://img.shields.io/npm/dt/@lint-ts-index/cli?label=cli&logo=npm)](https://npmjs.com/package/cli)

[![npm](https://img.shields.io/npm/dt/@lint-ts-index/eslint-plugin?label=eslint-plugin&logo=npm)](https://npmjs.com/package/eslint-plugin)

This is the monorepo for the lint-ts-index project. A set of tools to make sure that every files or subdirectories are exported in their corresponding `index.ts` files.

It contains the source code for the following NPM packages:

- [`@lint-ts-index/cli`](projects/cli/README.md) - A command-line interface.

- [`@lint-ts-index/eslint-plugin`](projects/eslint-plugin/README.md) - An eslint plugin.

- [`@lint-ts-index/core`](projects/core/README.md) - The core library where all the magic happens.

> :warning: **This project is still experimental and subject to important changes.

> Use it at your own risk**

## Contributing

This monorepo is managed by [Rush](https://rushjs.io/). Which means that you need to use `rush` and `rushx` commands instead of calling `npm` or `yarn`.

To update dependencies and build the project, just use :

```text

$ rush update

...

$ rush build

```

Please read the [Rush documentation](https://rushjs.io/pages/developer/new_developer/) for more advanced usage.

## License

These projects are licensed under the MIT license which you can find a copy in each project [`LICENSE`](LICENSE) file and at the root of this repository.