Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@rushstack/rig-package

Package Overview
Dependencies
Maintainers
3
Versions
44
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@rushstack/rig-package

A system for sharing tool configurations between projects without duplicating config files.

  • 0.5.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.1M
decreased by-30.39%
Maintainers
3
Weekly downloads
 
Created

What is @rushstack/rig-package?

The @rushstack/rig-package is part of the Rush Stack family of projects and is designed to help manage and share configurations across multiple projects in a monorepo. It allows developers to define a 'rig' package that contains shared configurations (like ESLint rules, TypeScript configs, etc.) and then easily consume those configurations in other projects within the monorepo. This approach helps in maintaining consistency and reducing duplication of configuration across projects.

What are @rushstack/rig-package's main functionalities?

Sharing ESLint configurations

This feature allows a project to extend ESLint configurations defined in a rig package. By specifying the path to the ESLint configuration in the rig package, the project can inherit and use those rules without having to duplicate the configuration.

{
  "extends": "./node_modules/@example/my-rig-package/profiles/default/eslint"
}

Sharing TypeScript configurations

This feature enables projects to extend TypeScript configurations from a rig package. It allows for a base tsconfig.json to be defined in the rig, which projects can then extend and override as necessary, promoting consistency across the codebase.

{
  "extends": "./node_modules/@example/my-rig-package/profiles/default/tsconfig.json",
  "compilerOptions": {
    /* Override specific compiler options here */
  }
}

Using shared scripts

Projects can utilize shared scripts defined in a rig package for common tasks like building or testing. This reduces the need for each project to maintain its own versions of these scripts, streamlining development workflows.

"scripts": {
  "build": "node ./node_modules/@example/my-rig-package/scripts/build.js"
}

Other packages similar to @rushstack/rig-package

FAQs

Package last updated on 27 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc