Skip to content

Commit

Permalink
📝
Browse files Browse the repository at this point in the history
  • Loading branch information
chengcyber committed Sep 26, 2023
1 parent 9bb2a0a commit d1ea6f3
Showing 1 changed file with 25 additions and 16 deletions.
41 changes: 25 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ This repo hosts a collection of third-party plugins for [RushJS](https://rushjs.
# rush-init-project-plugin

[![npm](https://img.shields.io/npm/dt/rush-init-project-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-init-project-plugin)
[![npm](https://img.shields.io/npm/dw/rush-init-project-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-init-project-plugin)

When you want to create a new project in your monorepo. There are highly chances you need copy and paste from a project already inside your monorepo. Why not reuse them, like create a project template and used in your monorepo. Yes, `rush-init-project-plugin` is for you!

Expand All @@ -11,47 +12,54 @@ When you want to create a new project in your monorepo. There are highly chances
# rush-upgrade-self-plugin

[![npm](https://img.shields.io/npm/dt/rush-upgrade-self-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-upgrade-self-plugin)
[![npm](https://img.shields.io/npm/dw/rush-upgrade-self-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-upgrade-self-plugin)

When you maintain a Rush.js managed monorepo, and you write some toolkit based on rush related module, such as `microsoft/rush-lib`, `@rushstack/node-core-library`. Things become trivial if you want to upgrade Rush.js to latest version. You need keep the versions of those dependencies in consistency. `rush-upgrade-self-plugin` comes into rescue, it aims to help you upgrade/downgrade Rush.js version in one line.

[More](./rush-plugins/rush-upgrade-self-plugin/README.md)

# rush-archive-project-plugin
# rush-sort-package-json

[![npm](https://img.shields.io/npm/dt/rush-archive-project-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-archive-project-plugin)
[![npm](https://img.shields.io/npm/dt/rush-sort-package-json.svg?style=flat-square)](https://www.npmjs.com/package/rush-sort-package-json)
[![npm](https://img.shields.io/npm/dw/rush-sort-package-json.svg?style=flat-square)](https://www.npmjs.com/package/rush-sort-package-json)

After you have tons of project in monorepo, install time gets slower, manage dependencies becomes harder, while some projects are eventually inactive. You just want a way to archive projects properly, and maybe retrieve one day :)
Now, it's time to give this plugin a try!
This plugin leverages the great work of [sort-package-json](https://www.npmjs.com/package/sort-package-json) to sort `package.json` in your monorepo, and keep it consistent.

[More](./rush-plugins/rush-archive-project-plugin/README.md)
[More](./rush-plugins/rush-sort-package-json/README.md)

# rush-lint-staged-plugin

[![npm](https://img.shields.io/npm/dt/rush-lint-staged-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-lint-staged-plugin)
[![npm](https://img.shields.io/npm/dw/rush-lint-staged-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-lint-staged-plugin)

Are you finding alternative to `husky` in your monorepo? Rush takes care of Git hooks natively by sync hook scripts under `common/git-hooks/` folder into `.git/hooks`. So, all you need is `lint-staged`. Use this plugin to setup `lint-staged` in your monorepo!

[More](./rush-plugins/rush-lint-staged-plugin/README.md)

# rush-print-log-if-error-plugin

[![npm](https://img.shields.io/npm/dt/rush-print-log-if-error-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-print-log-if-error-plugin)
[![npm](https://img.shields.io/npm/dw/rush-print-log-if-error-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-print-log-if-error-plugin)

Sometimes build errors are collapsed in a remote machine, use this plugin to print the entire log if error occurs.

[More](./rush-plugins/rush-print-log-if-error-plugin/README.md)

# rush-sort-package-json

[![npm](https://img.shields.io/npm/dt/rush-sort-package-json.svg?style=flat-square)](https://www.npmjs.com/package/rush-sort-package-json)

This plugin leverages the great work of [sort-package-json](https://www.npmjs.com/package/sort-package-json) to sort `package.json` in your monorepo, and keep it consistent.

[More](./rush-plugins/rush-sort-package-json/README.md)

# rush-lint-staged-plugin
# rush-archive-project-plugin

[![npm](https://img.shields.io/npm/dt/rush-lint-staged-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-lint-staged-plugin)
[![npm](https://img.shields.io/npm/dt/rush-archive-project-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-archive-project-plugin)
[![npm](https://img.shields.io/npm/dw/rush-archive-project-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-archive-project-plugin)

Are you finding alternative to `husky` in your monorepo? Rush takes care of Git hooks natively by sync hook scripts under `common/git-hooks/` folder into `.git/hooks`. So, all you need is `lint-staged`. Use this plugin to setup `lint-staged` in your monorepo!
After you have tons of project in monorepo, install time gets slower, manage dependencies becomes harder, while some projects are eventually inactive. You just want a way to archive projects properly, and maybe retrieve one day :)
Now, it's time to give this plugin a try!

[More](./rush-plugins/rush-lint-staged-plugin/README.md)
[More](./rush-plugins/rush-archive-project-plugin/README.md)

# rush-audit-cache-plugin

[![npm](https://img.shields.io/npm/dt/rush-audit-cache-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-audit-cache-plugin)
[![npm](https://img.shields.io/npm/dw/rush-audit-cache-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-audit-cache-plugin)

Use of rush build cache is a great way to speed up your build. But, how to know if the configuration for cache is working as expected? This plugin is for you!

Expand All @@ -60,6 +68,7 @@ Use of rush build cache is a great way to speed up your build. But, how to know
# rush-git-lfs-plugin

[![npm](https://img.shields.io/npm/dt/rush-git-lfs-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-git-lfs-plugin)
[![npm](https://img.shields.io/npm/dw/rush-git-lfs-plugin.svg?style=flat-square)](https://www.npmjs.com/package/rush-git-lfs-plugin)

Git LFS was commonly used to managed large files/binary files in your git repository. This plugin can help you to check if newly added files are correctly managed by Git LFS and prevent users from wrongly commit their local large files.

Expand Down

0 comments on commit d1ea6f3

Please sign in to comment.