Skip to content

refactor(types): Add NMF's ResolveData typed to public interface #17195

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

Merged
TheLarkInn merged 5 commits into from
May 16, 2023
Merged

refactor(types): Add NMF's ResolveData typed to public interface #17195

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64f70a4
refactor(types): Add NMF's ResolveData typed to public interface
TheLarkInn May 16, 2023
f5c981b
revert declarations change
TheLarkInn May 16, 2023
cfc427e
Add correct place to add ResolveData type
TheLarkInn May 16, 2023
9a26aa0
add small excerpt about contributing types to webpack
TheLarkInn May 16, 2023
ffb6baa
yarn fix
TheLarkInn May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add small excerpt about contributing types to webpack
  • Loading branch information
@TheLarkInn
TheLarkInn committed May 16, 2023
commit 9a26aa097a85469668433adf3d2e41862424cc70
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ greatly appreciate any time spent fixing typos or clarifying sections in the
documentation. [See a list of issues with the documentation tag](https://github.com/webpack/webpack/labels/documentation),
or [check out the issues on the documentation website's repository](https://github.com/webpack/webpack.js.org/issues).

## Types

webpack is statically typed using JSDoc annotation and TypeScript. If you would like to export a new type which doesn't belong to a public API, then you can do so by declaring it in `webpack/lib/index.js`.

`webpack/lib/index.js`
```js
/** @typedef {import("./NormalModuleFactory").ResolveData} ResolveData */
```

Then, automatically generate the type declarations by running `yarn fix` locally, and the changes you have made will be reflected in `types.d.ts`.

## Discussions

Gitter is only for small questions. To discuss a subject in detail, please send a link to your forum or blog in the Gitter chat.
Expand Down