Skip to content

esdoc/esdoc-importpath-plugin

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

This repository is deprecated.

Please check https://github.com/esdoc/esdoc-optional-plugins/tree/master/esdoc-importpath-plugin





Build Status codecov Document

ESDoc Import Path Plugin

This is a plugin that converts the import path in documentation. ESDoc displays the import path of class/function into the document. However, the import path may be different from real import path because usually ES6 is transpiled to use it.

For example, src/MyClass.js will be referred to as import MyClass from 'my-module/src/MyClass.js' in the documentation. However, in practice it is different from the real import path when you use because it is transpiled (for example, import MyClass from 'my-module/lib/MyClass.js').

Therefore, convert the import path by using following setting.

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {
      "name": "esdoc-importpath-plugin",
      "option": {
        "replaces": [
          {"from": "^src/", "to": "lib/"}
        ]
      }
    }
  ]
}

from is regular expression and tois letter. In the internal from and to are used with String#replace(new RegExp (from), to).

When writing multi rules, it will also be carried out transformation many times. For example, [{from: "^src/", to: "lib/"}, {from: "MyFooClass", to: "my-foo"}] converted as follows:

  • my-module/src/MyFooClass.js => my-module/lib/MyFooClass.js => my-module/lib/my-foo

Install and Usage

npm install esdoc-importpath-plugin

setup plugin property in esdoc.json

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {
      "name": "esdoc-importpath-plugin",
      "option": {
        "replaces": [
          {"from": "^src/", "to": "lib"}
        ]
      }
    }
  ]
}

execute ESDoc

esdoc -c esdoc.json

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru

About

[deprecated] Import Path Plugin for ESDoc

Resources

License

Stars

Watchers

Forks

Packages

No packages published