feat: import path plugin

Author: h13i32maru

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+out
+npm-debug.log
+/coverage
+/test/fixture/esdoc

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+sudo: false
+node_js:
+ - "0.12"
+script:
+ - TRAVIS=1 npm run test-es5
+install:
+ - npm install

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Next
+- **Feat**
+ - First Release

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ryo Maruyama
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,37 @@
+# ESDoc Import Path Plugin
+TODO
+
+# Install and Usage
+```sh
+npm install -g esdoc-importpath-plugin
+```
+
+setup ``plugin`` property in ``esdoc.json``
+
+```json
+{
+ "source": "./src",
+ "destination: "./doc",
+ "plugins": [
+ {
+ "name": "esdoc-importpath-plugin",
+ "option": {
+ "replaces": [
+ {"from": "^src/", "to": "lib"}
+ ]
+ }
+ }
+ ]
+}
+```
+
+execute ESDoc
+
+```json
+esdoc -c esdoc.json
+```
+
+# LICENSE
+MIT
+
+[Ryo Maruyama@h13i32maru](https://twitter.com/h13i32maru)

esdoc.json

@@ -0,0 +1,8 @@
+{
+ "source": "./src",
+ "destination": "./out/esdoc",
+ "test": {
+ "type": "mocha",
+ "source": "./test/src"
+ }
+}

package.json

@@ -0,0 +1,37 @@
+{
+ "name": "esdoc-importpath-plugin",
+ "version": "0.0.1",
+ "description": "Import Path Plugin For ESDoc",
+ "author": "h13i32maru",
+ "homepage": "https://github.com/esdoc/esdoc-importpath-plugin",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/esdoc/esdoc-importpath-plugin"
+ },
+ "scripts": {
+ "build": "node ./script/build.js",
+ "test": "node ./script/test.js",
+ "test-es5": "node ./script/test-es5.js"
+ },
+ "dependencies": {
+ "core-js": "^1.0.1"
+ },
+ "devDependencies": {
+ "babel": "^5.8.20",
+ "coveralls": "~2.11.2",
+ "esdoc": "^0.1.4",
+ "fs-extra": "^0.22.1",
+ "istanbul": "~0.3.16",
+ "mocha": "~2.2.5",
+ "power-assert": "^0.11.0"
+ },
+ "keywords": [
+ "esdoc"
+ ],
+ "files": [
+ "out/src",
+ "README.md"
+ ],
+ "main": "out/src/Plugin.js"
+}

script/build.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+var sh = require('./sh');
+
+sh.rm('./out/src');
+sh.mkdir('./out/src');
+sh.exec('./node_modules/.bin/babel --out-dir out/src src');
+
+// build test
+sh.rm('./out/test/src');
+sh.mkdir('./out/test/src');
+sh.exec('./node_modules/.bin/babel --out-dir out/test/src test/src');

script/sh.js

@@ -0,0 +1,35 @@
+var fs = require('fs-extra');
+var path = require('path');
+var child_process = require('child_process');
+
+function rm(path) {
+ fs.removeSync(path);
+}
+
+function mkdir(path) {
+ fs.mkdirs(path);
+}
+
+function exec(cmd) {
+ cmd = cmd.replace(/\//g, path.sep);
+ child_process.execSync(cmd, {stdio: 'inherit'});
+}
+
+function chmod(path, mode) {
+ fs.chmodSync(path, mode);
+}
+
+function cp(src, dst) {
+ fs.copySync(src, dst);
+}
+
+function cd(dst) {
+ process.chdir(dst);
+}
+
+module.exports.rm = rm;
+module.exports.mkdir = mkdir;
+module.exports.exec = exec;
+module.exports.chmod = chmod;
+module.exports.cp = cp;
+module.exports.cd = cd;

script/test-es5.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+var sh = require('./sh');
+
+var mochaOption=" -t 10000 --recursive ./out/test/src -R spec";
+
+sh.exec('node ./script/build.js');
+
+if (process.env.TRAVIS) {
+ sh.exec('./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- ' + mochaOption + ' && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js');
+} else if(process.argv.indexOf('--coverage') !== -1) {
+ sh.exec('./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha -- ' + mochaOption);
+} else {
+ sh.exec('./node_modules/.bin/mocha' + mochaOption);
+}