[Enhancement] A Post Processor is required for WebPack to remove @DynamicProtoStub tagged methods
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript, webpack
- Domain
- build-system
Research direction
Start with the README's description of the existing Rollup plugin and identify how the requested Webpack post processor should recognize each @DynamicProtoStub comment form. Done means the resulting Webpack code removes the tagged stub methods while the TypeScript declarations retain the prototype-level definitions.
Written by the indexing model from the issue text.
Description
While a rollup plugin is available to remove the stub functions tagged with @DynamicProtoStub, we should really look at providing a version for WebPack.
As per the readme, tagged functions/methods should be removed from the resulting code as they are necessary to ensure that TypeScript provides the correct resulting definition (*.d.ts) where the functions are declared as "prototype" level functions.
/**
* The typedoc comments
*/
// @DynamicProtoStub
public toBeRemoved():void {
}
// @DynamicProtoStub
public toBeRemoved():void {
}
/**
* This function does stuff
* @param args - used in the function
*/
public myFunction(args:string): void {
...
} // @DynamicProtoStub - Function will be removed
public myFunction2(): void {
...
} // @DynamicProtoStub - Function will be removed
/**
* This function does stuff
* @param args - used in the function
*/
public myFunction(args:string): void {
// @DynamicProtoStub - Function will be removed
}
public myFunction2(): void {
/* @DynamicProtoStub
* Function will be removed
*/
}
- Dominant language
- TypeScript
- Stars
- 28
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/DynamicProto-JS
-
microsoft/DynamicProto-JS#95 · 1 comment · 1 reaction · 1 assignee ·
-
ES6
Difficulty 3/5 1-2 days Newbie friendliness 35/100
microsoft/DynamicProto-JS#38 ·
All issues in microsoft/DynamicProto-JS
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
keytrace logo svg?Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
HigherOrderCO/Bend#1294 ·
-
Price: 75 USD Priority: 2 (Medium) Time: <1 Hour
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day