[!IMPORTANT] This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.

Table of Contents

• Storm Software - Banner Plugin for ESLint
  • Installing
  • Rules
  • Options
  • Configurations
  • Building
  • Running unit tests
  • Storm Workspaces
  • Roadmap
  • Support
  • License
  • Changelog
  • Contributing
  • Contributors

Storm Software - Banner Plugin for ESLint

This package provides an ESLint plugin that enforces the presence of a standardized banner comment at the top of source files. The banner includes important information about the project, such as licensing, contact information, and links to documentation.

Installing

Using pnpm:

pnpm add -D @storm-software/eslint-plugin-banner

npm install -D @storm-software/eslint-plugin-banner

yarn add -D @storm-software/eslint-plugin-banner

Rules

💼 Configurations enabled in.
🌟 Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.

| Name   | Description | 💼 | 🔧 | | :----------------------------- | :---------------------------------------------------------------------------------- | :-- | :-- | | banner | Ensures the file has a organization specific banner at the top of source code files | 🌟 | 🔧 |

Options

The following options are available for this plugin:

| Name | Description | Type | Choices | Required | | :------------- | :-------------------------------------------------------------------------- | :----- | :---------------- | :------- | | commentStyle | The comment token to use for the banner. Defaults to block ('//') | String | | | | docs | The documentation URL to include in the banner. | String | | | | homepage | The homepage URL to include in the banner. | String | | | | license | The project license to include in the banner. | String | | | | licensing | The licensing URL to include in the banner. | String | | | | lineEndings | The type of line endings to use. Defaults to the system default | String | unix, windows | | | name | The name of the repository to use when reading the banner from a file. | String | | Yes | | newlines | The number of newlines to use after the banner. Defaults to 1 | Number | | | | organization | The organization to include in the banner. | String | | | | repository | The repository URL to include in the banner. | String | | |

Configurations

The following configurations are available for this plugin:

| | Name | | :-- | :------------ | | 🌟 | recommended |

Building

Run nx build eslint-plugin-banner to build the library.

Running unit tests

Run nx test eslint-plugin-banner to execute the unit tests via Jest.

Storm Workspaces

Storm workspaces are built using Nx, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• Contact
• GitHub discussions
• [email protected]

License

This project is licensed under the Apache License 2.0. Feel free to edit and distribute this template as you like.

See LICENSE for more information.

Changelog

This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file

Contributing

First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Please adhere to this project's code of conduct.

You can use markdownlint-cli to check for common markdown style inconsistency.

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud.

Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.

Join us on Discord to chat with the team, receive release notifications, ask questions, and get involved.

If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website or join our Slack channel!