You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Define your own codegen function, which will receive all options specified. Import the `Preset` type from this library to define a strongly-typed preset function:
148
+
Define your own codegen function, which will receive all options specified.
149
+
150
+
Import the `Preset` type from this library to define a strongly-typed preset function:
149
151
150
152
##### Example
151
153
@@ -164,7 +166,12 @@ This can be used in other files by specifying the `source` option like:
<br /> Note that some helpers passed via `dependencies`, such as `glob`, `fs`, `path`, `child_process`, `lodash`, `jsYaml`, `dedent`, and `readPkgUp`, corresponding to those node modules respectively. These can be useful to allow access to those libraries without them being production dependencies. This also allows your lint process to use these node-only dependencies, even in a file that is not run in node - only the calls would be included in any bundled output, not the dependencies themselves.
169
+
<br />
170
+
171
+
Note that some helpers passed via `dependencies`, such as `glob`, `fs`, `path`, `child_process`, `lodash`, `jsYaml`, `dedent`, and `readPkgUp`, corresponding to those
172
+
node modules respectively. These can be useful to allow access to those libraries without them being production dependencies.
173
+
This also allows your lint process to use these node-only dependencies, even in a file that is not run in node - only the calls would be included in any
Copies a whole other file. Useful for "borrowing" an implementation of a simple utility from another project, without needing to publish it. Obviously this creates duplicated code, so use judiciously!
280
+
Copies a whole other file. Useful for "borrowing" an implementation of a simple utility from another project, without needing to publish it.
281
+
Obviously this creates duplicated code, so use judiciously!
Use a test file to generate library usage documentation. Note: this has been tested with vitest and jest. It _might_ also work fine with mocha, and maybe ava, but those haven't been tested. JSDoc/inline comments above tests will be added as a "preamble", making this a decent way to quickly document API usage of a library, and to be sure that the usage is real and accurate.
445
+
Use a test file to generate library usage documentation.
446
+
447
+
Note: this has been tested with vitest and jest. It _might_ also work fine with mocha, and maybe ava, but those haven't been tested.
448
+
449
+
JSDoc/inline comments above tests will be added as a "preamble", making this a decent way to quickly document API usage of a library,
450
+
and to be sure that the usage is real and accurate.
434
451
435
452
##### Example
436
453
@@ -454,7 +471,11 @@ Use a test file to generate library usage documentation. Note: this has been tes
Generates a yaml config for the [GitHub Pull Request Labeler Action](https://github.com/actions/labeler). Creates a label per package name, which will be applied to any file modified under the leaf package path. When packages are added or removed from the repo, or renamed, the yaml config will stay in sync with them. Additional labels can be added outside of the generated code block. See https://github.com/mmkal/ts/tree/main/.github/labeler.yml for an example.
474
+
Generates a yaml config for the [GitHub Pull Request Labeler Action](https://github.com/actions/labeler).
475
+
Creates a label per package name, which will be applied to any file modified under the leaf package path.
476
+
When packages are added or removed from the repo, or renamed, the yaml config will stay in sync with them.
477
+
Additional labels can be added outside of the generated code block.
478
+
See https://github.com/mmkal/ts/tree/main/.github/labeler.yml for an example.
0 commit comments