Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add a plugin system #402

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

feat: add a plugin system #402

wants to merge 30 commits into from
+49,892 −12,645

Conversation

boneskull
Copy link
Owner

@boneskull boneskull commented Oct 10, 2023 •
edited
Loading

This adds a plugin system so we can separate things like rules (and eventually package manager implementations from the main codebase), and others can write custom plugins providing the same.

All rules have moved into the @midnight-smoker/plugin-default package.

Pluginable Things

  • Package managers
  • Rules
  • Reporters

Limitations

Plugins currently cannot interact with each other nor declare dependencies on other plugins. Eventually I imagine someone might want to, say, override a rule.

TODO

  • List of plugins to load must be user-specified. Probably unwise to attempt automatic discovery (or make it opt-in). This will necessarily invoke multiple passes through options validation.
  • Rules created by 3rd party plugins must be scoped to the plugin name.
  • Need to assert the plugin name matches the package name.
  • Docs
    • Plugin guide
    • Usage guide
    • Getting started guide
    • Rules reference
    • CLI reference
    • Config reference
  • Anything else in the milestone

Future

  • Plugins should be allowed to define command-line options

@boneskull
Copy link
Owner Author

boneskull commented Oct 10, 2023 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @boneskull and the rest of your teammates on Graphite Graphite

This was referenced Oct 10, 2023
Merged
Closed
Base automatically changed from monorepo to main October 10, 2023 02:08
@boneskull boneskull force-pushed the plugin-support branch 2 times, most recently from 181aead to d55ad27 Compare October 11, 2023 00:08
@boneskull boneskull self-assigned this Oct 11, 2023
@boneskull boneskull force-pushed the plugin-support branch 2 times, most recently from a5ad1ef to 1758954 Compare October 11, 2023 07:00
@boneskull boneskull marked this pull request as ready for review October 11, 2023 07:12
@boneskull boneskull changed the base branch from main to docsify October 11, 2023 21:40
@boneskull boneskull mentioned this pull request Oct 11, 2023
Merged
@boneskull boneskull added the enhancement New feature or request label Oct 11, 2023
Base automatically changed from docsify to main October 11, 2023 21:58
@boneskull boneskull force-pushed the plugin-support branch 11 times, most recently from 4bd3120 to b9a5fd8 Compare October 13, 2023 04:27
@boneskull
chore(plugin-default): update pm data on publish
4644ea8
@boneskull
chore(wallaby): revert adding test-util to wallaby
5b15e86 
as of right now, it's just an E2E test in there
@boneskull
fix(midnight-smoker): cleanup
797c717 
- remove some leftover stuff I forgot to pull out
- add `Smoker.getDefaultPkgManager()` which necessarily invokes a couple actors
@boneskull
chore(ci): remove node v18 from matrix
c80a605
@boneskull
fix(midnight-smoker): fix smoke tests, add missing dep
b1e2ade
@boneskull
fix(midnight-smoker): fix SmokeError output
ce20180
@boneskull
chore(midnight-smoker): update snapshots
5208fe4
@boneskull
chore: disable snapshots for now
f162e54
@boneskull
chore(midnight-smoker): update snapshots
532abad
@boneskull
chore: update test scripts
c12e3e1
@boneskull
chore(test-util): fix tests
8ca435a 
re-add to wallaby
@boneskull
fix(deps): update corepack
a1a9fa7
@boneskull
chore: fiddle with some tests
25194ed
@boneskull
chore(ci): fix matrix
dad83d2
@boneskull
chore(plugin-default): lint
f3672ea
@boneskull
chore(plugin-default): windows compat test
35f3ff8
@boneskull
fix(midnight-smoker): windows compat, maybe
90e811d
@boneskull
chore(midnight-smoker): readPkgJson also returns raw source
9f27ee0
@boneskull
chore(midnight-smoker): WIP json source mapper thing
d792497
@boneskull
feat: rules can display source file context
a894b0b
@boneskull
chore: enable noUncheckedIndexAccess
29e7c0e 
also fiddle w/ JSONBlamer tests
@boneskull
chore: cleanup Smoker; add note about exit reporter
952c756
@boneskull
fix(midnight-smoker): bad type in util/hwp
e0ecc4c
@boneskull
chore(deps): upgrade TS, lint-staged, markdownlint-cli2
0229d75
@boneskull
chore: mostly replace Boolean with !!
6e95249 
Ref: microsoft/TypeScript#16655
@boneskull
chore(midnight-smoker): move unsupported pkg manager filter
98e4359
@boneskull
chore: enable isolated modules
572d273
@boneskull
chore(midnight-smoker): create SpawnError
9726f6f
@boneskull
fix: post-tinyexec fixes
c7696a7 
- fix many errors & broken tests
- change many module specifiers to be internal
- update some docstrings
- create wrapper for some common `lodash` guards
- fix exec result and error handling
- what was `ExecResult` is now `ExecOutput`. `ExecResult` is a `PromiseLike`
- fix deps and exports in `test-util`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@boneskull boneskull

Labels
enhancement New feature or request
Projects
None yet
Milestone
v9
Development

Successfully merging this pull request may close these issues.
1 participant
@boneskull