@rmtc/plugin-ignore-files v1.1.1

@rmtc/plugin-ignore-files

A plugin for @rmtc/toolchain that ensures .gitignore and .npmignore files have a core set of statements.

!WARNING This project is intended for use in @rowanmanning's projects. It's free to use but I don't offer support for use-cases outside of what I need.

Table of Contents

• Requirements
• Usage
  • Workflows
  • Steps
  • Configuration
• Contributing
• License

Requirements

This library requires the following to run:

• Node.js 18+
• The @rmtc/toolchain CLI

Usage

Install the module with npm:

npm install --save-dev @rmtc/plugin-ignore-files

Include it in your .rmtc.json file:

{
    plugins: [
        // ...
        '@rmtc/plugin-ignore-files'
    ]
    // ...
}

Workflows

This plugin defines the following workflows:

• postinstall: a general workflow used to indicate steps that should be run after dependencies have been installed.

Steps

This plugin defines the following steps that can be added to any workflow:

• ignore-files:install: add statements to the .gitignore file and .npmignore if either the package is non-private or it has workspaces defined.

Configuration

This plugin provides no additional configuration.

Contributing

See the central README for a contribution guide and code of conduct.

License

Licensed under the MIT license. Copyright © 2023, Rowan Manning