Research
Recent Trends in Malicious Packages Targeting Discord
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
typedoc-plugin-external-module-map
Advanced tools
Readme
A plugin for Typedoc
When trying to unify documentation for multiple modules residing inside a shared source repository, the default way Typedoc assignes top-level module names might not satisfy.
This plugin allows you to specify a regular expression with a capture group. This is then used to collect related items into one module.
This plugin is inspired by, and based on, https://github.com/christopherthielen/typedoc-plugin-external-module-name , but does not require you to add additional annotations to each .ts file in your project.
Suppose you have
module/@mycompany/thing1/index.ts
module/@mycompany/thing1/src/otherfiles.ts
module/@mycompany/thing2/index.ts
module/@mycompany/thing2/src/otherfiles.ts
Typedoc will create four "External Modules", named for each .ts file.
This plugin allows each file to specify the Typedoc External Module its code should belong to. If multiple files belong to the same module, they are merged.
This allows more control over the modules that Typedoc generates. Instead of the four modules above, we could group them into two:
Typedoc 0.4 has the ability to discover and load typedoc plugins found in node_modules. Simply install the plugin and run typedoc.
However, Typedoc 0.24 did away with that, so now you have to specify it explicitly every time.
npm install --save typedoc-plugin-external-module-map
typedoc --plugin typedoc-plugin-external-module-map
This plugin adds a new input option
--external-modulemap ".*\/modules\/@mycompany\/([\\w\\-_]+)\/"
If you specify it from the command line, be sure to escape the input string so bash doesn't expand it.
It is probably easier to create a typedoc options file (typedoc.json) and add it there:
{
"name": "My Library",
"mode": "modules",
"out": "doc",
"theme": "default",
"ignoreCompilerErrors": "false",
"preserveConstEnums": "true",
"exclude": "*.spec.ts",
"external-modulemap": ".*\/modules\/@mycompany\/([\\w\\-_]+)\/",
"stripInternal": "false"
}
If your pattern is not expressable in a single regexp, you can provide an array of regexps in the .json file. First to match will return the value.
Example:
{
"name": "My Library",
"mode": "modules",
"out": "doc",
"theme": "default",
"ignoreCompilerErrors": "false",
"preserveConstEnums": "true",
"exclude": "*.spec.ts",
"external-modulemap": [
".*/(types/[\\w\\-_]+)/",
".*/(core/decorators/[\\w\\-_]+)/",
".*/subfolder/(core/[\\w\\-_]+)/",
],
"stripInternal": "false"
}
The new features in Typedoc of "entryPointStrategy": "packages"
, or using @group
or @category
with the appropriate base plugins have mostly superseeded this plugin, but there are still a few cases in which it makes sense. Ie if you have sub-packages, or multiple entry points.
In these cases, you use the entrypoint strategy for the top level navigation, and then in the individual projects, place a typedoc.json with the external-modulemap configuration specific to the package.
The configuration will not be picked up from the top-level typedoc.json
FAQs
Specify the Typedoc Module of a file using a regular expression on the filename
The npm package typedoc-plugin-external-module-map receives a total of 5,313 weekly downloads. As such, typedoc-plugin-external-module-map popularity was classified as popular.
We found that typedoc-plugin-external-module-map demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.