speced / speced/respec

New API for external plugins

Open
#1,976 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

The current plugin API depends on AMD module system (via requirejs) and exposes internal modules. This blocks #1975 and causes potential breaking changes when any internal functions change.

We may introduce a new API that looks something like webpack one:

var respecConfig = {
   // ...
   plugins: [
     new MyPlugin()
   ]
};

@sidvishnoi @marcoscaceres Thoughts?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current external plugin API, its AMD/RequireJS dependency, and the webpack plugin anatomy linked in the issue. Done would mean agreeing on and documenting a stable plugin interface that avoids exposing internal modules; the issue does not name files, tests, or an implementation entry point.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.