![](\"./image/github.png\"/)
![](\"./image/brand_logo')
');\n }\n\n // title\n if (this._title) {\n const $title = $('title');\n const original = $title.text();\n $title.text(`${original} | ${this._title}`);\n }\n\n // repository\n if (this._repository) {\n if (this._repository.indexOf('https://github.com/') === 0) {\n const style = 'style=\"position:relative; top:3px;\"';\n $('header').append(``);\n } else {\n $('header').append(`Repository`);\n }\n }\n\n // meta tag\n this._addMetaTag($);\n\n ev.data.content = $.html();\n }\n\n _getRepositoryURL(packageObj) {\n if (!packageObj.repository) return null;\n\n let url = packageObj.repository.url || packageObj.repository;\n if (typeof url !== 'string') return null;\n\n if (url.indexOf('git@github.com:') === 0) { // url: git@github.com:foo/bar.git\n const matched = url.match(/^git@github\\.com:(.*)\\.git$/);\n return `https://github.com/${matched[1]}`;\n } else if (url.match(/^[\\w\\d\\-_]+\\/[\\w\\d\\-_]+$/)) { // url: foo/bar\n return `https://github.com/${url}`;\n } else if (url.match(/^git\\+https:\\/\\/github.com\\/.*\\.git$/)) { // git+https://github.com/foo/bar.git\n const matched = url.match(/^git\\+(https:\\/\\/github.com\\/.*)\\.git$/);\n return matched[1];\n } else if (url.match(/(https?:\\/\\/.*$)/)) { // other url\n const matched = url.match(/(https?:\\/\\/.*$)/);\n return matched[1];\n }\n\n return null;\n }\n\n _getAuthor(packageObj) {\n if (!packageObj.author) return null;\n\n if (typeof packageObj.author === 'string') {\n return packageObj.author;\n } else {\n return packageObj.author.url || packageObj.author.name;\n }\n }\n\n _addMetaTag($) {\n const metaProps = [];\n\n // normal\n if (this._description){\n metaProps.push({name: 'description', content: this._description});\n }\n\n // og tag http://ogp.me/#metadata\n if (this._title && this._image && this._site){\n metaProps.push({property: 'og:type', content: 'website'});\n metaProps.push({property: 'og:url', content: this._site});\n metaProps.push({property: 'og:site_name', content: this._title});\n metaProps.push({property: 'og:title', content: this._title});\n metaProps.push({property: 'og:image', content: this._image});\n\n if (this._description) metaProps.push({property: 'og:description', content: this._description});\n if (this._author) metaProps.push({property: 'og:author', content: this._author});\n }\n\n // twitter card https://dev.twitter.com/cards/types/summary\n if (this._title && this._description){\n metaProps.push({property: 'twitter:card', content: 'summary'});\n metaProps.push({property: 'twitter:title', content: this._title});\n metaProps.push({property: 'twitter:description', content: this._description});\n\n if (this._image) metaProps.push({property: 'twitter:image', content: this._image});\n if (this._site && this._site.indexOf('https://twitter.com/') === 0) {\n const twitterName = this._site.replace('https://twitter.com/', '@');\n metaProps.push({property: 'twitter:site', content: twitterName});\n metaProps.push({property: 'twitter:creator', content: twitterName});\n }\n }\n\n const $head = $('head');\n for (const metaProp of metaProps) {\n const prop = Object.keys(metaProp).map((key) => `${key}=\"${metaProp[key]}\"`).join(' ');\n const metaTag = ``;\n $head.append(metaTag);\n }\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-brand-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"package\": \"./test/package.json\",\n \"plugins\": [\n {\"name\": \"./test/misc/publish-html-mock-plugin.js\"},\n {\"name\": \"./src/Plugin.js\", \"option\": {\"logo\": \"./test/misc/logo.png\", \"image\": \"https://esdoc.org/manual/asset/image/logo.png\"}}\n ]\n}\n"
},
{
"path": "esdoc-brand-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-brand-plugin/test/misc/publish-html-mock-plugin.js",
"content": "exports.onPublish = function(ev) {\n const html = `\n\n\n\n![](\"https://esdoc.org/image/top.png\")
\n\n## Feature\n- Generates detailed document.\n- Measures document coverage.\n- Integrate test codes into documentation.\n- [ESDoc Hosting Service](https://doc.esdoc.org)\n\n## Demo\n- [ESDoc](https://esdoc.org/esdoc) is self-hosting 😄\n\n## License\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://twitter.com/h13i32maru)\n"
},
{
"path": "esdoc-integrate-manual-plugin/test/manual/tutorial.md",
"content": "# Tutorial\nthis is tutorial.\n"
},
{
"path": "esdoc-integrate-manual-plugin/test/manual/usage1.md",
"content": "# Usage\n\n```sh\nesdoc -c esdoc.json\n```\n\n``esdoc.json``\n\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\"\n}\n```\n"
},
{
"path": "esdoc-integrate-manual-plugin/test/manual/usage2.md",
"content": "# Usage2\nthis is usage2\n\n## h2 in usage2\nthis is h2 in usage2\n\n### h3 in usage2\nthis is h2 in usage3\n"
},
{
"path": "esdoc-integrate-manual-plugin/test/src/Dummy.js",
"content": "export default class TestDummy {}\n"
},
{
"path": "esdoc-integrate-manual-plugin/test/util.js",
"content": "const fs = require('fs');\n\nexports.find = function(key, ...values) {\n if (values.length === 1) {\n return global.docs.find((doc) => {\n if (typeof values[0] === 'string') return doc[key] === values[0];\n if (values[0] instanceof RegExp) return doc[key].match(values[0]);\n });\n }\n\n const results = [];\n for (const value of values) {\n const result = global.docs.find(doc => {\n if (typeof value === 'string') return doc[key] === value;\n if (value instanceof RegExp) return doc[key].match(value);\n });\n\n results.push(result);\n }\n\n return results;\n};\n\nexports.file = function (filePath) {\n return fs.readFileSync(filePath).toString();\n};\n\n"
},
{
"path": "esdoc-integrate-test-plugin/CHANGELOG.md",
"content": "# Changelog\n\n## 1.0.0 (2017-07-30)\n- Release\n"
},
{
"path": "esdoc-integrate-test-plugin/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2015 Ryo Maruyama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "esdoc-integrate-test-plugin/README.md",
"content": "# ESDoc Integrate Test Plugin\n## Install\n```bash\nnpm install esdoc-integrate-test-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./docs\",\n \"plugins\": [\n {\n \"name\": \"esdoc-integrate-test-plugin\",\n \"option\": {\n \"source\": \"./test/\",\n \"interfaces\": [\"describe\", \"it\", \"context\", \"suite\", \"test\"],\n \"includes\": [\"(spec|Spec|test|Test)\\\\.js$\"],\n \"excludes\": [\"\\\\.config\\\\.js$\"]\n }\n }\n ]\n}\n```\n\n- `source` is required\n- `interfaces` default is `[\"describe\", \"it\", \"context\", \"suite\", \"test\"]`\n- `includes` default is `[\"(spec|Spec|test|Test)\\\\.js$\"]`\n- `excludes` default is `[\"\\\\.config\\\\.js$\"]`\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-integrate-test-plugin/package.json",
"content": "{\n \"name\": \"esdoc-integrate-test-plugin\",\n \"version\": \"1.0.0\",\n \"description\": \"A integrate test plugin for ESDoc\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"test\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-integrate-test-plugin/src/Plugin.js",
"content": "const assert = require('assert');\nconst path = require('path');\nconst fs = require('fs');\nconst TestDocFactory = require('./TestDocFactory');\n\n// hack\nconst ESParser = require('esdoc/out/src/Parser/ESParser').default;\nconst InvalidCodeLogger = require('esdoc/out/src/Util/InvalidCodeLogger').default;\nconst PathResolver = require('esdoc/out/src/Util/PathResolver').default;\nconst ASTUtil = require('esdoc/out/src/Util/ASTUtil').default;\n\nclass Plugin {\n onHandleDocs(ev) {\n this._docs = ev.data.docs;\n this._option = ev.data.option;\n\n this._exec();\n }\n\n _exec() {\n this._setDefault();\n\n const docs = this._generateDocs();\n this._docs.push(...docs);\n }\n\n _setDefault() {\n if (!this._option) return;\n\n const option = this._option;\n assert(option.source);\n if (!option.interfaces) option.interfaces = ['describe', 'it', 'context', 'suite', 'test'];\n if (!option.includes) option.includes = ['(spec|Spec|test|Test)\\\\.js$'];\n if (!option.excludes) option.excludes = ['\\\\.config\\\\.js$'];\n }\n\n /**\n * Generate document from test code.\n */\n _generateDocs() {\n const option = this._option;\n const results = [];\n\n if (!option) return results;\n\n const includes = option.includes.map((v) => new RegExp(v));\n const excludes = option.excludes.map((v) => new RegExp(v));\n const sourceDirPath = path.resolve(option.source);\n\n this._walk(option.source, (filePath)=>{\n const relativeFilePath = path.relative(sourceDirPath, filePath);\n let match = false;\n for (const reg of includes) {\n if (relativeFilePath.match(reg)) {\n match = true;\n break;\n }\n }\n if (!match) return;\n\n for (const reg of excludes) {\n if (relativeFilePath.match(reg)) return;\n }\n\n console.log(`parse: ${filePath}`);\n const temp = this._traverse(option.interfaces, option.source, filePath);\n if (!temp) return;\n results.push(...temp.results);\n\n // todo: enable work\n // asts.push({filePath: `test${path.sep}${relativeFilePath}`, ast: temp.ast});\n });\n\n return results;\n }\n\n /**\n * walk recursive in directory.\n * @param {string} dirPath - target directory path.\n * @param {function(entryPath: string)} callback - callback for find file.\n * @private\n */\n _walk(dirPath, callback) {\n const entries = fs.readdirSync(dirPath);\n\n for (const entry of entries) {\n const entryPath = path.resolve(dirPath, entry);\n const stat = fs.statSync(entryPath);\n\n if (stat.isFile()) {\n callback(entryPath);\n } else if (stat.isDirectory()) {\n this._walk(entryPath, callback);\n }\n }\n }\n\n /**\n * traverse doc comment in test code file.\n * @param {string[]} interfaces - test interface names.\n * @param {string} inDirPath - root directory path.\n * @param {string} filePath - target test code file path.\n * @returns {Object} return document info that is traversed.\n * @property {DocObject[]} results - this is contained test code.\n * @property {AST} ast - this is AST of test code.\n * @private\n */\n _traverse(interfaces, inDirPath, filePath) {\n let ast;\n try {\n ast = ESParser.parse(filePath);\n } catch (e) {\n InvalidCodeLogger.showFile(filePath, e);\n return null;\n }\n const pathResolver = new PathResolver(inDirPath, filePath);\n const factory = new TestDocFactory(interfaces, ast, pathResolver);\n\n ASTUtil.traverse(ast, (node, parent)=>{\n try {\n factory.push(node, parent);\n } catch (e) {\n InvalidCodeLogger.show(filePath, node);\n throw e;\n }\n });\n\n return {results: factory.results, ast: ast};\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-integrate-test-plugin/src/TestDoc.js",
"content": "// hack: depends on esdoc internal class\nconst AbstractDoc = require('esdoc/out/src/Doc/AbstractDoc').default;\nconst ParamParser = require('esdoc/out/src/Parser/ParamParser').default;\n\n/**\n * Doc Class from test code file.\n */\nclass TestDoc extends AbstractDoc {\n /**\n * apply own tag.\n * @private\n */\n _apply() {\n super._apply();\n\n this._$testTarget();\n\n Reflect.deleteProperty(this._value, 'export');\n Reflect.deleteProperty(this._value, 'importPath');\n Reflect.deleteProperty(this._value, 'importStyle');\n }\n\n /** use name property of self node. */\n _$kind() {\n super._$kind();\n\n this._value.kind = 'test';\n }\n\n /** set name and testId from special esdoc property. */\n _$name() {\n super._$name();\n\n this._value.name = this._node._esdocTestName;\n this._value.testId = this._node._esdocTestId;\n }\n\n /** set memberof to use parent test nod and file path. */\n _$memberof() {\n super._$memberof();\n\n const chain = [];\n let parent = this._node.parent;\n while (parent) {\n if (parent._esdocTestName) chain.push(parent._esdocTestName);\n parent = parent.parent;\n }\n\n const filePath = this._pathResolver.filePath;\n\n if (chain.length) {\n this._value.memberof = `${filePath}~${chain.reverse().join('.')}`;\n this._value.testDepth = chain.length;\n } else {\n this._value.memberof = filePath;\n this._value.testDepth = 0;\n }\n }\n\n /** set describe by using test node arguments. */\n _$desc() {\n super._$desc();\n if (this._value.description) return;\n\n this._value.description = this._node.arguments[0].value;\n }\n\n /** for @testTarget. */\n _$testTarget() {\n const values = this._findAllTagValues(['@test', '@testTarget']);\n if (!values) return;\n\n this._value.testTargets = [];\n for (const value of values) {\n const {typeText} = ParamParser.parseParamValue(value, true, false, false);\n this._value.testTargets.push(typeText);\n }\n }\n\n _$test() {\n // alias of testTarget\n }\n}\n\nmodule.exports = TestDoc;\n"
},
{
"path": "esdoc-integrate-test-plugin/src/TestDocFactory.js",
"content": "const assert = require('assert');\nconst TestDoc = require('./TestDoc');\nconst TestFileDoc = require('./TestFileDoc');\n// hack: depends on ESDoc internal class\nconst CommentParser = require('esdoc/out/src/Parser/CommentParser').default;\n\nconst already = Symbol('already');\n\n/**\n * Test doc factory class.\n * @example\n * let factory = new TestDocFactory('mocha', ast, pathResolver);\n * factory.push(node, parentNode);\n * let results = factory.results;\n */\nclass TestDocFactory {\n /**\n * get unique id.\n * @returns {number} unique id.\n * @private\n */\n static _getUniqueId() {\n if (!this._sequence) /** @type {number} */ this._sequence = 0;\n\n return this._sequence++;\n }\n\n /**\n * @type {DocObject[]}\n */\n get results() {\n return [...this._results];\n }\n\n /**\n * create instance.\n * @param {string[]} interfaces - test interface names.\n * @param {AST} ast - AST of test code.\n * @param {PathResolver} pathResolver - path resolver of test code.\n */\n constructor(interfaces, ast, pathResolver) {\n /** @type {string} */\n this._interfaces = interfaces;\n\n /** @type {AST} */\n this._ast = ast;\n\n /** @type {PathResolver} */\n this._pathResolver = pathResolver;\n\n /** @type {DocObject[]} */\n this._results = [];\n\n // file doc\n const doc = new TestFileDoc(ast, ast, pathResolver, []);\n this._results.push(doc.value);\n }\n\n /**\n * push node, and factory process the node.\n * @param {ASTNode} node - target node.\n * @param {ASTNode} parentNode - parent node of target node.\n */\n push(node, parentNode) {\n if (node[already]) return;\n\n node[already] = true;\n Reflect.defineProperty(node, 'parent', {value: parentNode});\n\n this._push(node);\n }\n\n /**\n * push node as mocha test code.\n * @param {ASTNode} node - target node.\n * @private\n */\n _push(node) {\n if (node.type !== 'ExpressionStatement') return;\n\n const expression = node.expression;\n if (expression.type !== 'CallExpression') return;\n\n if (!this._interfaces.includes(expression.callee.name)) return;\n\n expression[already] = true;\n Reflect.defineProperty(expression, 'parent', {value: node});\n\n let tags = [];\n if (node.leadingComments && node.leadingComments.length) {\n const comment = node.leadingComments[node.leadingComments.length - 1];\n tags = CommentParser.parse(comment);\n }\n\n const uniqueId = this.constructor._getUniqueId();\n expression._esdocTestId = uniqueId;\n expression._esdocTestName = expression.callee.name + uniqueId;\n\n const testDoc = new TestDoc(this._ast, expression, this._pathResolver, tags);\n\n this._results.push(testDoc.value);\n }\n}\n\nmodule.exports = TestDocFactory;\n"
},
{
"path": "esdoc-integrate-test-plugin/src/TestFileDoc.js",
"content": "// hack: depends on esdoc internal class\nconst FileDoc = require('esdoc/out/src/Doc/FileDoc').default;\n\n/**\n * Doc class for test code file.\n */\nclass TestFileDoc extends FileDoc {\n /** set ``testFile`` to kind. */\n _$kind() {\n this._value.kind = 'testFile';\n }\n}\n\nmodule.exports = TestFileDoc;\n"
},
{
"path": "esdoc-integrate-test-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"plugins\": [\n {\n \"name\": \"./src/Plugin.js\",\n \"option\": {\n \"source\": \"./test/test\",\n \"excludes\": [\"\\\\.test\\\\.js$\"]\n }\n }\n ]\n}\n"
},
{
"path": "esdoc-integrate-test-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-integrate-test-plugin/test/src/Dummy.js",
"content": "export default class Dummy {\n}\n"
},
{
"path": "esdoc-integrate-test-plugin/test/test/Test.js",
"content": "/**\n * @test {TestTarget1}\n */\ndescribe('describe/', ()=>{\n /**\n * @test {TestTarget2}\n */\n it('describe/it', ()=>{});\n\n /**\n * @test {TestTarget3}\n */\n describe('describe/describe/', ()=>{\n /**\n * @test {TestTarget4}\n */\n it('describe/describe/it', ()=>{});\n });\n\n /**\n * @test {TestTarget5}\n */\n context('describe/context/', ()=>{\n /**\n * @test {TestTarget6}\n */\n it('describe/context/it', ()=>{});\n });\n});\n\n/**\n * @test {TestTarget7}\n */\nsuite('suite/', ()=>{\n /**\n * @test {TestTarget8}\n */\n test('suite/test', ()=>{});\n\n /**\n * @test {TestTarget9}\n */\n suite('suite/suite/', ()=>{\n /**\n * @test {TestTarget10}\n */\n test('suite/suite/test', ()=>{});\n })\n});\n"
},
{
"path": "esdoc-integrate-test-plugin/test/test/Test.test.js",
"content": "const assert = require('assert');\nconst {find} = require('../util');\n\ndescribe('test/Test.js:', ()=>{\n it('has describe/', ()=>{\n const doc = find('longname', 'test/Test.js~describe0');\n assert.equal(doc.testId, 0);\n assert.equal(doc.testDepth, 0);\n assert.equal(doc.description, 'describe/');\n assert.deepEqual(doc.testTargets, ['TestTarget1']);\n });\n\n it('has describe/it', ()=>{\n const doc = find('longname', 'test/Test.js~describe0.it1');\n assert.equal(doc.testId, 1);\n assert.equal(doc.testDepth, 1);\n assert.equal(doc.description, 'describe/it');\n assert.deepEqual(doc.testTargets, ['TestTarget2']);\n });\n\n it('has describe/describe', ()=>{\n const doc = find('longname', 'test/Test.js~describe0.describe2');\n assert.equal(doc.testId, 2);\n assert.equal(doc.testDepth, 1);\n assert.equal(doc.description, 'describe/describe/');\n assert.deepEqual(doc.testTargets, ['TestTarget3']);\n });\n\n it('has describe/describe/it', ()=>{\n const doc = find('longname', 'test/Test.js~describe0.describe2.it3');\n assert.equal(doc.testId, 3);\n assert.equal(doc.testDepth, 2);\n assert.equal(doc.description, 'describe/describe/it');\n assert.deepEqual(doc.testTargets, ['TestTarget4']);\n });\n\n it('has describe/context/it', ()=>{\n const doc = find('longname', 'test/Test.js~describe0.context4.it5');\n assert.equal(doc.testId, 5);\n assert.equal(doc.testDepth, 2);\n assert.equal(doc.description, 'describe/context/it');\n assert.deepEqual(doc.testTargets, ['TestTarget6']);\n });\n\n it('has suite/', ()=>{\n const doc = find('longname', 'test/Test.js~suite6');\n assert.equal(doc.testId, 6);\n assert.equal(doc.testDepth, 0);\n assert.equal(doc.description, 'suite/');\n assert.deepEqual(doc.testTargets, ['TestTarget7']);\n });\n\n it('has suite/test', ()=>{\n const doc = find('longname', 'test/Test.js~suite6.test7');\n assert.equal(doc.testId, 7);\n assert.equal(doc.testDepth, 1);\n assert.equal(doc.description, 'suite/test');\n assert.deepEqual(doc.testTargets, ['TestTarget8']);\n });\n\n it('has suite/suite/', ()=>{\n const doc = find('longname', 'test/Test.js~suite6.suite8');\n assert.equal(doc.testId, 8);\n assert.equal(doc.testDepth, 1);\n assert.equal(doc.description, 'suite/suite/');\n assert.deepEqual(doc.testTargets, ['TestTarget9']);\n });\n\n it('has suite/suite/test', ()=>{\n const doc = find('longname', 'test/Test.js~suite6.suite8.test9');\n assert.equal(doc.testId, 9);\n assert.equal(doc.testDepth, 2);\n assert.equal(doc.description, 'suite/suite/test');\n assert.deepEqual(doc.testTargets, ['TestTarget10']);\n });\n});\n\n\n"
},
{
"path": "esdoc-integrate-test-plugin/test/util.js",
"content": "const fs = require('fs');\n\nexports.find = function(key, ...values) {\n if (values.length === 1) {\n return global.docs.find((doc) => {\n if (typeof values[0] === 'string') return doc[key] === values[0];\n if (values[0] instanceof RegExp) return doc[key].match(values[0]);\n });\n }\n\n const results = [];\n for (const value of values) {\n const result = global.docs.find(doc => {\n if (typeof value === 'string') return doc[key] === value;\n if (value instanceof RegExp) return doc[key].match(value);\n });\n\n results.push(result);\n }\n\n return results;\n};\n\nexports.file = function (filePath) {\n return fs.readFileSync(filePath).toString();\n};\n\n"
},
{
"path": "esdoc-jsx-plugin/CHANGELOG.md",
"content": "# Changelog\n\n## 1.0.0 (2017-07-30)\n- Release\n"
},
{
"path": "esdoc-jsx-plugin/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2015 Ryo Maruyama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "esdoc-jsx-plugin/README.md",
"content": "# ESDoc JSX Plugin\n## Install\n```bash\nnpm install esdoc-jsx-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\"name\": \"esdoc-jsx-plugin\", \"option\": {\"enable\": true}}\n ]\n}\n```\n\n- `enable` is default `true`\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-jsx-plugin/package.json",
"content": "{\n \"name\": \"esdoc-jsx-plugin\",\n \"version\": \"1.0.0\",\n \"description\": \"A JSX plugin for ESDoc\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"jsx\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-jsx-plugin/src/Plugin.js",
"content": "class Plugin {\n onHandleCodeParser(ev) {\n const option = ev.data.option || {};\n const plugins = ev.data.parserOption.plugins;\n\n if (!('enable' in option)) option.enable = true;\n\n if (option.enable) plugins.push('jsx');\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-jsx-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"plugins\": [\n {\"name\": \"./src/Plugin.js\"}\n ]\n}\n"
},
{
"path": "esdoc-jsx-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-jsx-plugin/test/src/MyClass.js",
"content": "export default class MyClass {\n method(){\n return | \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
Sorry, this documentation does not provide source code.
\n" }, { "path": "esdoc-publish-html-plugin/src/Builder/template/identifiers.html", "content": "![](\"./image/search.png\"/)
\n \n \n | Name | Type | Attribute | Description |
| \n | \n | \n | \n |
\"+a+\"\";\nb=b.firstChild;f&&L(b,f,!0);M({j:d,m:f,h:b,l:1,a:null,i:null,c:null,g:null});return b.innerHTML},prettyPrint:E.prettyPrint=function(a,d){function f(){for(var b=E.PR_SHOULD_USE_CONTINUATION?c.now()+250:Infinity;p
![](\"./badge.svg\"){kind=icon}
| File | \nIdentifier | \nDocument | \nSize | \nLines | \nUpdated | \n
| \n | \n | \n | \n | \n | \n |
| \n \n \n \n \n \n | \n\n \n \n \n \n \n \n \n \n\n \n \n \n \n | \n \n version \n since \n | \n
| Description | \nIdentifier | \n
![](\"./manual-badge.svg\"/){kind=icon}
') inCode = true;\n else if (char5 === '') inCode = false;\n\n if (inSQuote || inCode || inWQuote) continue;\n\n if (char1 === '.') {\n if (char2 === ' ' || char2 === '\\n' || char2 === '<') {\n len = i + 1;\n break;\n }\n } else if (char1 === '\\n' && char2 === '\\n') {\n len = i + 1;\n break;\n }\n }\n\n let result = desc.substr(0, len);\n if (asMarkdown) {\n result = markdown(result);\n }\n\n return result;\n}\n\n/**\n * convert markdown text to html.\n * @param {string} text - markdown text.\n * @param {boolean} [breaks=false] if true, break line. FYI gfm is not breaks.\n * @return {string} html.\n */\nexport function markdown(text, breaks = false) {\n // original render does not support multi-byte anchor\n const renderer = new marked.Renderer();\n renderer.heading = function (text, level) {\n const id = escapeURLHash(text);\n return `${escape(code)}${escape(code)}`;\n }\n });\n\n return compiled;\n}\n\n/**\n * get UTC date string.\n * @param {Date} date - target date object.\n * @returns {string} UTC date string(yyyy-mm-dd hh:mm:ss)\n */\nexport function dateForUTC(date) {\n function pad(num, len) {\n const count = Math.max(0, len - `${num}`.length);\n return '0'.repeat(count) + num;\n }\n\n const year = date.getUTCFullYear();\n const month = pad(date.getUTCMonth() + 1, 2);\n const day = pad(date.getUTCDay() + 1, 2);\n const hours = pad(date.getUTCHours(), 2);\n const minutes = pad(date.getUTCMinutes(), 2);\n const seconds = pad(date.getUTCSeconds(), 2);\n\n return `${year}-${month}-${day} ${hours}:${minutes}:${seconds} (UTC)`;\n}\n\n/**\n * parse ``@example`` value.\n * ``@example`` value can have ``![](\"https://esdoc.org/manual/asset/image/top.png\")
\n\n## Feature\n- Generates detailed document.\n- Measures document coverage.\n- Integrate test codes into documentation.\n- [ESDoc Hosting Service](https://doc.esdoc.org)\n\n## Demo\n- [ESDoc](https://esdoc.org/esdoc) is self-hosting 😄\n\n## License\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://twitter.com/h13i32maru)\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/manual/tutorial.md",
"content": "# Tutorial\nthis is tutorial.\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/manual/usage1.md",
"content": "# Usage\n\n```sh\nesdoc -c esdoc.json\n```\n\n``esdoc.json``\n\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\"\n}\n```\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/manual/usage2.md",
"content": "# Usage2\nthis is usage2\n\n## h2 in usage2\nthis is h2 in usage2\n\n### h3 in usage2\nthis is h2 in usage3\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/package.json",
"content": "{\n \"name\": \"esdoc-test-fixture\",\n \"version\": \"1.2.3\",\n \"private\": true,\n \"description\": \"this is esdoc-publish-html-plugin fixture\",\n \"author\": {\n \"name\": \"h13i32maru\",\n \"url\": \"http://h13i32maru.jp\"\n },\n \"homepage\": \"http://esdoc.org\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc\"\n },\n \"main\": \"./src/Class/Definition.js\"\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Abstract/Definition.js",
"content": "/**\n * this is TestAbstractDefinition.\n */\nexport default class TestAbstractDefinition {\n /**\n * this is abstract method1.\n * @abstract\n */\n method1(){}\n\n /**\n * this is abstract method2.\n * @abstract\n */\n method2(){}\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Abstract/Override.js",
"content": "import TestAbstractDefinition from './Definition';\n\n/**\n * this is TestAbstractOverride\n */\nexport default class TestAbstractOverride extends TestAbstractDefinition {\n /**\n * this is override method1.\n * @override\n */\n method1(){}\n\n /**\n * this is override method2 with automatically detection.\n */\n method2(){}\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Access/Class.js",
"content": "/**\n * this is TestAccessClassPublic.\n * @public\n */\nexport default class TestAccessClassPublic {}\n\n/**\n * this is TestAccessClassProtected.\n * @protected\n */\nexport class TestAccessClassProtected {}\n\n/**\n * this is TestAccessClassPrivate.\n * @private\n */\nexport class TestAccessClassPrivate {}\n\n/**\n * this is TestAccessClassAutoPrivate.\n */\nexport class _TestAccessClassAutoPrivate {}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Access/Function.js",
"content": "/**\n * this is testAccessFunctionPublic.\n * @public\n */\nexport default function testAccessFunctionPublic(){}\n\n/**\n * this is testAccessFunctionProtected.\n * @protected\n */\nexport function testAccessFunctionProtected(){}\n\n/**\n * this is testAccessFunctionPrivate.\n * @private\n */\nexport function testAccessFunctionPrivate(){}\n\n/**\n * this is testAccessFunctionAutoPrivate.\n */\nexport function _testAccessFunctionAutoPrivate(){}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Access/Method.js",
"content": "/**\n * this is TestAccessMethod.\n */\nexport default class TestAccessMethod {\n /**\n * this is method1.\n * @public\n */\n method1(){}\n\n /**\n * this is method2.\n * @protected\n */\n method2(){}\n\n /**\n * this is method3.\n * @private\n */\n method3(){}\n\n /**\n * this is _method4.\n */\n _method4(){}\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Access/Property.js",
"content": "/**\n * this is TestAccessProperty.\n */\nexport default class TestAccessProperty {\n constructor() {\n /**\n * this is p1.\n * @public\n * @type {number}\n */\n this.p1 = 123;\n\n /**\n * this is p2.\n * @protected\n * @type {number}\n */\n this.p2 = 123;\n\n /**\n * this is p3.\n * @private\n * @type {number}\n */\n this.p3 = 123;\n\n /**\n * this is _p4.\n * @type {number}\n */\n this._p4 = 123;\n }\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Access/Variable.js",
"content": "/**\n * this is testAccessVariablePublic.\n * @type {number}\n * @public\n */\nexport const testAccessVariablePublic = 123;\n\n/**\n * this is testAccessVariableProtected.\n * @type {number}\n * @protected\n */\nexport const testAccessVariableProtected = 123;\n\n/**\n * this is testAccessVariablePrivate.\n * @type {number}\n * @private\n */\nexport const testAccessVariablePrivate = 123;\n\n/**\n * this is _testAccessVariableAutoPrivate.\n * @type {number}\n */\nexport const _testAccessVariableAutoPrivate = 123;\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Async/Function.js",
"content": "/**\n * this is testAsyncFunction.\n */\nexport default async function testAsyncFunction(){}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Async/Method.js",
"content": "/**\n * this is TestAsyncMethod.\n */\nexport default class TestAsyncMethod {\n /**\n * this is async method1.\n */\n async method1(){}\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Class/Definition.js",
"content": "/**\n * this is TestClassDefinition.\n */\nexport default class TestClassDefinition {\n /**\n * this is static method1.\n */\n static method1(){\n /**\n * this is static p1.\n * @type {number}\n */\n this.p1 = 123;\n }\n\n /**\n * this is get value1.\n * @type {number}\n */\n get value1(){}\n\n /**\n * this is set value2.\n * @type {number}\n */\n set value2(v){}\n\n /**\n * this is constructor.\n */\n constructor(){\n /**\n * this is p1.\n * @type {number}\n */\n this.p1 = 123;\n }\n\n /**\n * this is method1.\n */\n method1(){}\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/ClassProperty/Definition.js",
"content": "/**\n * this is TestClassPropertyDefinition.\n * @todo test `Access`, `Deprecated`, `Desc`, `Duplication`, `Example`, `Experimental`, `Guess`, `Ignore`, `Link`, `See`, `Since`, `Todo` and `Version`.\n */\nexport default class TestClassPropertyDefinition {\n /**\n * this is static p1.\n * @type {number}\n */\n static p1 = 123;\n\n /**\n * this is p1.\n * @type {number}\n */\n p1 = 123;\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Computed/Method.js",
"content": "/**\n * this is TestComputedMethod\n */\nexport default class TestComputedMethod {\n /**\n * this is foo.\n */\n ['foo'](){}\n\n /**\n * this is iterator.\n */\n [Symbol.iterator]() { }\n\n /**\n * this is [foo].\n */\n [foo](){}\n\n /**\n * this is [foo.bar.baz].\n */\n [foo.bar.baz](){}\n\n /**\n * this is [foo + bar].\n */\n [foo + bar](){}\n\n /**\n * this is [foo.p + bar].\n */\n [foo.p + bar](){}\n\n /**\n * this is [foo()].\n */\n [foo()](){}\n\n /**\n * this is [foo.bar()].\n */\n [foo.bar()](){}\n\n /**\n * this is [`${foo}`].\n */\n [`${foo}`](){}\n\n /**\n * this is *[foo.bar]\n */\n *[foo.bar](){}\n}\n\n/**\n * @ignore\n */\nconst foo = '';\n\n/**\n * @ignore\n */\nconst bar = '';\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Computed/Property.js",
"content": "/**\n * this is TestComputedProperty\n */\nexport default class TestComputedProperty {\n /**\n * this is constructor.\n */\n constructor(){\n /**\n * this is foo.\n * @type {number}\n */\n this['foo'] = 123;\n\n /**\n * this is iterator.\n * @type {number}\n */\n this[Symbol.iterator] = 123;\n\n /**\n * this is [foo].\n * @type {number}\n */\n this[foo] = 123;\n\n /**\n * this is [foo.bar].\n * @type {number}\n */\n this[foo.bar] = 123;\n\n /**\n * this is [foo.bar.baz].\n * @type {number}\n */\n this[foo.bar.baz] = 123;\n\n /**\n * this is [foo + bar].\n * @type {number}\n */\n this[foo + bar] = 123;\n\n /**\n * this is [foo.p + bar].\n * @type {number}\n */\n this[foo.p + bar] = 123;\n\n /**\n * this is [foo()].\n * @type {number}\n */\n this[foo()] = 123;\n\n /**\n * this is [foo.bar()].\n * @type {number}\n */\n this[foo.bar()] = 123;\n\n /**\n * this is [`${foo}`].\n * @type {number}\n */\n this[`${foo}`] = 123;\n }\n}\n\n/**\n * @ignore\n */\nconst foo = '';\n\n/**\n * @ignore\n */\nconst bar = '';\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Decorator/Definition.js",
"content": "/**\n * this is TestDecoratorDefinition.\n */\n@testDecoratorAnnotation1\nexport default class TestDecoratorDefinition {\n /**\n * this is static method1.\n */\n @testDecoratorAnnotation1\n static method1(){}\n\n /**\n * this is get value1.\n * @type {number}\n */\n @testDecoratorAnnotation1\n get value1(){}\n\n /**\n * this is set value2.\n * @type {number}\n */\n @testDecoratorAnnotation1\n set value2(v){}\n\n /**\n * this is method1.\n */\n @testDecoratorAnnotation1\n @testDecoratorAnnotation2(true)\n method1(){}\n}\n\n/**\n * this is testDecoratorAnnotation1.\n */\nexport function testDecoratorAnnotation1(){}\n\n/**\n * this is testDecoratorAnnotation2.\n */\nexport function testDecoratorAnnotation2(){}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Deprecated/Class.js",
"content": "/**\n * this is TestDeprecatedClass.\n * @deprecated this is deprecated.\n */\nexport default class TestDeprecatedClass {\n constructor() {\n /**\n * this is p1.\n * @type {number}\n * @deprecated\n */\n this.p1 = 123;\n }\n\n /**\n * this is method1.\n * @deprecated\n */\n method1(){}\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Deprecated/Function.js",
"content": "/**\n * this is testDeprecatedFunction.\n * @deprecated\n */\nexport default function testDeprecatedFunction(){}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Deprecated/Variable.js",
"content": "/**\n * this is testDeprecatedVariable.\n * @deprecated\n */\nexport const testDeprecatedVariable = 123;\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Desc/Class.js",
"content": "/**\n * @desc this is TestDescClass.\n */\nexport default class TestDescClass {\n /**\n * @desc this is constructor.\n */\n constructor() {\n /**\n * @desc this is p1.\n * @type {number}\n */\n this.p1 = 123;\n }\n\n /**\n * @desc this is method1.\n */\n method1(){}\n}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Desc/Function.js",
"content": "/**\n * @desc this is testDescFunction.\n */\nexport default function testDescFunction(){}\n"
},
{
"path": "esdoc-publish-html-plugin/test/fixture/src/Desc/Markdown.js",
"content": "/**\n * this is TestDescMarkdown.\n *\n * ```html\n * ![](\"https://raw.githubusercontent.com/esdoc/esdoc-plugins/master/esdoc-publish-markdown-plugin/misc/ss.png\")
\n\n## Install\n```bash\nnpm install esdoc-publish-markdown-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\n \"name\": \"esdoc-publish-markdown-plugin\",\n \"option\": {\n \"filename\":\"README.md\"\n }\n }\n ]\n}\n```\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-publish-markdown-plugin/misc/index.md",
"content": "# Class\n\n## `MyClass`\n\nthis is MyClass\n\n### `constructor()`\n\nthis is constructor\n\n### `member1: number`\n\nthis is member1.\n\n### `member2: string`\n\nthis is member2.\n\n### `method1(p1: ...number): boolean`\n\nthis is method1.\n\n| Name | Type | Attribute | Description |\n| --- | --- | --- | --- |\n| p1 | ...number | | this is p1 |\n\n### `method2(p1: number)`\n\nthis is method2.\n\n| Name | Type | Attribute | Description |\n| --- | --- | --- | --- |\n| p1 | number | optional: true, default: 10 | this is p1 |\n\n# Function\n\n## `myFunction(p1: number): string`\n\nthis is myFunction\n\n| Name | Type | Attribute | Description |\n| --- | --- | --- | --- |\n| p1 | number | | this is p1. |"
},
{
"path": "esdoc-publish-markdown-plugin/package.json",
"content": "{\n \"name\": \"esdoc-publish-markdown-plugin\",\n \"version\": \"1.0.0\",\n \"description\": \"A publish markdown plugin for ESDoc [PoC]\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"dependencies\": {\n \"ice-cap\": \"0.0.4\",\n \"to-markdown\": \"3.0.4\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"markdown\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-publish-markdown-plugin/src/AbstractBuilder.js",
"content": "const path = require('path');\nconst fs = require('fs');\n\nclass AbstractBuilder {\n constructor(docs) {\n this._docs = docs;\n }\n\n makeHTML() {\n return '';\n }\n\n _findAll(cond = {}) {\n const keys = Object.keys(cond);\n return this._docs.filter((doc) =>{\n for (const key of keys) if (doc[key] !== cond[key]) return false;\n return true;\n });\n }\n\n _find(cond = {}) {\n return this._findAll(cond)[0];\n }\n\n _makeSignature(doc) {\n if (['constructor', 'method', 'function'].includes(doc.kind)) {\n let params = [];\n if (doc.params) params = doc.params.map(param => `${param.name}: ${param.types.join('|')}`);\n const type = doc.return ? `: ${doc.return.types.join('|')}` : '';\n return `\\`${doc.name}(${params.join(', ')})${type}\\``;\n }\n\n if (['member', 'variable'].includes(doc.kind)) {\n const type = doc.type ? doc.type.types.join('|') : '*';\n return `\\`${doc.name}: ${type}\\``;\n }\n }\n\n _makeParamAttribute(param) {\n const attrs = [];\n if (param.nullable !== null) attrs.push(`nullable: ${param.nullable}`);\n if (param.optional) attrs.push('optional: true');\n if (param.defaultValue) attrs.push(`default: ${param.defaultValue}`);\n\n return attrs.join(', ');\n }\n\n _readTemplate(fileName) {\n const filePath = path.resolve(__dirname, `./template/${fileName}`);\n return fs.readFileSync(filePath, {encoding: 'utf-8'});\n }\n}\n\nmodule.exports = AbstractBuilder;\n"
},
{
"path": "esdoc-publish-markdown-plugin/src/ClassBuilder.js",
"content": "const AbstractBuilder = require('./AbstractBuilder');\nconst IceCap = require('ice-cap').default;\n\nclass ClassBuilder extends AbstractBuilder {\n makeHTML() {\n const docs = this._findAll({kind: 'class'});\n const outputs = [];\n\n for (const doc of docs) {\n const ice = new IceCap(this._readTemplate('class.html'));\n\n this._applyBody(doc, ice);\n this._applyConstructor(doc, ice);\n this._applyMember(doc, ice);\n this._applyMethod(doc, ice);\n\n outputs.push(ice.html);\n }\n\n return outputs.join('\\n');\n }\n\n _applyBody(classDoc, ice) {\n ice.text('className', `\\`${classDoc.name}\\``);\n ice.text('classDesc', classDoc.description);\n }\n\n _applyConstructor(classDoc, ice) {\n const constructorDoc = this._find({kind: 'constructor', memberof: classDoc.longname});\n if (constructorDoc) {\n ice.text('constructorSignature', this._makeSignature(constructorDoc));\n ice.text('constructorDesc', constructorDoc.description);\n }\n }\n\n _applyMember(classDoc, ice) {\n const memberDocs = this._findAll({kind: 'member', memberof: classDoc.longname});\n ice.loop('member', memberDocs, (index, doc, ice) =>{\n ice.text('memberSignature', this._makeSignature(doc));\n ice.text('memberDesc', doc.description);\n });\n }\n\n _applyMethod(classDoc, ice) {\n const methodDocs = this._findAll({kind: 'method', memberof: classDoc.longname});\n ice.loop('method', methodDocs, (index, doc, ice) =>{\n ice.text('methodSignature', this._makeSignature(doc));\n ice.text('methodDesc', doc.description);\n\n const params = doc.params || [];\n ice.loop('methodParam', params, (index, param, ice) =>{\n ice.text('name', param.name);\n ice.text('type', param.types.join('|'));\n ice.text('attribute', this._makeParamAttribute(param) || ' ');\n ice.text('desc', param.description);\n });\n });\n }\n}\n\nmodule.exports = ClassBuilder;\n"
},
{
"path": "esdoc-publish-markdown-plugin/src/FunctionBuilder.js",
"content": "const AbstractBuilder = require('./AbstractBuilder');\nconst IceCap = require('ice-cap').default;\n\nclass FunctionBuilder extends AbstractBuilder {\n makeHTML() {\n const docs = this._docs.filter(doc => doc.kind === 'function');\n const outputs = [];\n\n for (const doc of docs) {\n const ice = new IceCap(this._readTemplate('function.html'));\n this._applyBody(doc, ice);\n this._applyParam(doc, ice);\n outputs.push(ice.html);\n }\n\n return outputs.join('\\n');\n }\n\n _applyBody(doc, ice) {\n ice.text('functionName', this._makeSignature(doc));\n ice.text('functionDesc', doc.description);\n }\n\n _applyParam(doc, ice) {\n const params = doc.params || [];\n ice.loop('functionParam', params, (index, param, ice) =>{\n ice.text('name', param.name);\n ice.text('type', param.types.join('|'));\n ice.text('attribute', this._makeParamAttribute(param) || ' ');\n ice.text('desc', param.description);\n });\n }\n}\n\nmodule.exports = FunctionBuilder;\n"
},
{
"path": "esdoc-publish-markdown-plugin/src/Plugin.js",
"content": "const toMarkdown = require('to-markdown');\nconst ClassBuilder = require('./ClassBuilder');\nconst FunctionBuilder = require('./FunctionBuilder');\n\nclass Plugin {\n onHandleDocs(ev) {\n this._docs = ev.data.docs;\n }\n\n onPublish(ev) {\n\n // create builder\n const classBuilder = new ClassBuilder(this._docs);\n const functionBuilder = new FunctionBuilder(this._docs);\n\n // create html\n let html = '';\n html += '| Name | \nType | \nAttribute | \nDescription | \n
| \n | \n | \n | \n |
| Name | \nType | \nAttribute | \nDescription | \n
| \n | \n | \n | \n |
![](\"https://raw.githubusercontent.com/esdoc/esdoc-plugins/master/esdoc-react-plugin/misc/ss.png\")
\n\n## Install\n```bash\nnpm install esdoc-react-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\"name\": \"esdoc-standard-plugin\"},\n {\"name\": \"esdoc-react-plugin\"}\n ]\n}\n```\n\n## Dependency\n- esdoc-standard-plugin\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-react-plugin/package.json",
"content": "{\n \"name\": \"esdoc-react-plugin\",\n \"version\": \"1.0.1\",\n \"description\": \"A React plugin for ESDoc [PoC]\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"dependencies\": {\n \"cheerio\": \"1.0.0-rc.1\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"esdoc-standard-plugin\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"react\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-react-plugin/src/Plugin.js",
"content": "const path = require('path');\nconst cheerio = require('cheerio');\nconst ParamParser = require('esdoc/out/src/Parser/ParamParser').default;\nconst DocBuilder = require('esdoc-publish-html-plugin/out/src/Builder/DocBuilder').default;\n\nclass Plugin {\n constructor() {\n this._docs = null;\n this._reactPropsDocs = null;\n }\n\n onHandleDocs(ev) {\n this._docs = ev.data.docs;\n\n const reactPropsDocs = [];\n for (const doc of ev.data.docs) {\n if (doc.kind !== 'class') continue;\n if (!doc.unknown) continue;\n\n const reactProps = doc.unknown.filter(v => v.tagName === '@reactProps');\n if (!reactProps.length) continue;\n\n reactPropsDocs.push({\n longname: doc.longname,\n fileName: `${doc.longname}.html`,\n reactProps: reactProps\n });\n }\n\n this._reactPropsDocs = reactPropsDocs;\n }\n\n onHandleContent(ev) {\n const content = ev.data.content;\n const fileName = ev.data.fileName;\n\n // only html\n if (path.extname(fileName) !== '.html') return;\n\n // find target doc\n const doc = this._reactPropsDocs.find(doc => {\n const regexp = new RegExp(`${doc.fileName}$`);\n if (fileName.match(regexp)) return true;\n });\n if (!doc) return;\n\n // create esdoc properties from react props\n const properties = doc.reactProps.map(reactProp => {\n const {typeText, paramName, paramDesc} = ParamParser.parseParamValue(reactProp.tagValue);\n return ParamParser.parseParam(typeText, paramName, paramDesc);\n });\n\n // hack: create html\n const docBuilder = DocBuilder.createDefaultBuilder();\n const html = docBuilder._buildProperties(properties, 'React Props:').html;\n\n // append html\n const $ = cheerio.load(content);\n $('.self-detail.detail').append(html);\n\n ev.data.content = $.html();\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-react-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"plugins\": [\n {\"name\": \"esdoc-standard-plugin\"},\n {\"name\": \"./src/Plugin.js\"}\n ]\n}\n"
},
{
"path": "esdoc-react-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-react-plugin/test/src/MyClass.js",
"content": "/**\n * This is MyClass.\n * @reactProps {!number} prop1 - this is prop1\n * @reactProps {string} prop2 - this is prop2\n */\nexport default class MyClass extends React.Component {\n}\n\n/**\n * this is NonReactClass\n */\nexport class NonReactClass {\n}\n"
},
{
"path": "esdoc-react-plugin/test/src/MyClass.test.js",
"content": "const assert = require('assert');\nconst {load, text} = require('../util');\n\ndescribe('test/MyClass.js:', ()=> {\n it('has React props', ()=>{\n const $ = load('./test/out/class/src/MyClass.js~MyClass.html');\n const $table = $('.self-detail.detail [data-ice=\"properties\"]');\n\n assert.equal(text($table, 'tbody tr:nth-child(1)'), 'prop1 number nullable: false this is prop1');\n assert.equal(text($table, 'tbody tr:nth-child(2)'), 'prop2 string this is prop2');\n });\n\n it('does not have React props', ()=>{\n const $ = load('./test/out/class/src/MyClass.js~NonReactClass.html');\n const $table = $('.self-detail.detail [data-ice=\"properties\"]');\n\n assert.equal($table.length, 0);\n });\n});\n\n"
},
{
"path": "esdoc-react-plugin/test/util.js",
"content": "const fs = require('fs');\nconst cheerio = require('cheerio');\n\nmodule.exports.load = function(fileName) {\n const html = fs.readFileSync(fileName, {encoding: 'utf-8'});\n return cheerio.load(html);\n};\n\nmodule.exports.text = function($el, query) {\n return $el.find(query).text().replace(/\\s+/g, ' ').trim();\n};\n"
},
{
"path": "esdoc-standard-plugin/CHANGELOG.md",
"content": "# Changelog\n\n## 1.0.0 (2017-07-30)\n- Release\n"
},
{
"path": "esdoc-standard-plugin/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2015 Ryo Maruyama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "esdoc-standard-plugin/README.md",
"content": "# ESDoc Standard Plugin\n## Install\n```bash\nnpm install esdoc-standard-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\n \"name\": \"esdoc-standard-plugin\",\n \"option\": {\n \"lint\": {\"enable\": true},\n \"coverage\": {\"enable\": true},\n \"accessor\": {\"access\": [\"public\", \"protected\", \"private\"], \"autoPrivate\": true},\n \"undocumentIdentifier\": {\"enable\": true},\n \"unexportedIdentifier\": {\"enable\": false},\n \"typeInference\": {\"enable\": true},\n \"brand\": {\n \"logo\": \"./logo.png\",\n \"title\": \"My Library\",\n \"description\": \"this is awesome library\",\n \"repository\": \"https://github.com/foo/bar\",\n \"site\": \"http://my-library.org\",\n \"author\": \"https://twitter.com/foo\",\n \"image\": \"http://my-library.org/logo.png\"\n },\n \"manual\": {\n \"index\": \"./manual/index.md\",\n \"globalIndex\": true,\n \"asset\": \"./manual/asset\",\n \"files\": [\n \"./manual/overview.md\",\n \"./manual/design.md\",\n \"./manual/installation.md\",\n \"./manual/usage1.md\",\n \"./manual/usage2.md\",\n \"./manual/tutorial.md\",\n \"./manual/configuration.md\",\n \"./manual/example.md\",\n \"./manual/advanced.md\",\n \"./manual/faq.md\",\n \"./CHANGELOG.md\"\n ]\n },\n \"test\": {\n \"source\": \"./test/\",\n \"interfaces\": [\"describe\", \"it\", \"context\", \"suite\", \"test\"],\n \"includes\": [\"(spec|Spec|test|Test)\\\\.js$\"],\n \"excludes\": [\"\\\\.config\\\\.js$\"]\n }\n }\n }\n ]\n}\n```\n\nThe `esdoc-standard-plugin` is a glue plugin. The following plugins are used by this.\n- [esdoc-lint-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-lint-plugin)\n- [esdoc-coverage-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-coverage-plugin)\n- [esdoc-accessor-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-accessor-plugin)\n- [esdoc-type-inference-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-type-inference-plugin)\n- [esdoc-external-ecmascript-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-external-ecmascript-plugin)\n- [esdoc-brand-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-brand-plugin)\n- [esdoc-undocumented-identifier-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-undocumented-identifier-plugin)\n- [esdoc-unexported-identifier-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-unexported-identifier-plugin)\n- [esdoc-integrate-manual-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-integrate-manual-plugin)\n- [esdoc-integrate-test-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-integrate-test-plugin)\n- [esdoc-publish-html-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-publish-html-plugin)\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-standard-plugin/package.json",
"content": "{\n \"name\": \"esdoc-standard-plugin\",\n \"version\": \"1.0.0\",\n \"description\": \"A standard plugin for ESDoc\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"dependencies\": {\n \"esdoc-lint-plugin\": \"^1.0.0\",\n \"esdoc-coverage-plugin\": \"^1.0.0\",\n \"esdoc-accessor-plugin\": \"^1.0.0\",\n \"esdoc-external-ecmascript-plugin\": \"^1.0.0\",\n \"esdoc-brand-plugin\": \"^1.0.0\",\n \"esdoc-undocumented-identifier-plugin\": \"^1.0.0\",\n \"esdoc-unexported-identifier-plugin\": \"^1.0.0\",\n \"esdoc-publish-html-plugin\": \"^1.0.0\",\n \"esdoc-type-inference-plugin\": \"^1.0.0\",\n \"esdoc-integrate-manual-plugin\": \"^1.0.0\",\n \"esdoc-integrate-test-plugin\": \"^1.0.0\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"standard\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-standard-plugin/src/Plugin.js",
"content": "class Plugin {\n onHandlePlugins(ev) {\n const option = ev.data.option || {};\n const plugins = [\n {name: 'esdoc-lint-plugin', option: option.lint},\n {name: 'esdoc-coverage-plugin', option: option.coverage},\n {name: 'esdoc-accessor-plugin', option: option.accessor},\n {name: 'esdoc-type-inference-plugin', option: option.typeInference},\n {name: 'esdoc-external-ecmascript-plugin'},\n {name: 'esdoc-brand-plugin', option: option.brand},\n {name: 'esdoc-undocumented-identifier-plugin', option: option.undocumentIdentifier},\n {name: 'esdoc-unexported-identifier-plugin', option: option.unexportedIdentifier},\n {name: 'esdoc-integrate-manual-plugin', option: option.manual},\n {name: 'esdoc-integrate-test-plugin', option: option.test},\n {name: 'esdoc-publish-html-plugin'}\n ];\n\n const existPluginNames = ev.data.plugins.map(plugin => plugin.name);\n for (const plugin of plugins) {\n if (existPluginNames.includes(plugin.name)) continue;\n if (plugin.option === undefined) delete plugin.option;\n ev.data.plugins.push(plugin);\n }\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-standard-plugin/test/README.md",
"content": "[](https://travis-ci.org/esdoc/esdoc)\n[](https://coveralls.io/r/esdoc/esdoc)\n\n# ESDoc Test Fixture\nthis is ESDoc Test Fixture README.\n\n- item1\n- item2\n- item3\n\n1st line.\nsecond line.\n\nhttp://github.com/h13i32maru/esdoc\n\n```javascript\nexport default class Foo {\n static get foo() {}\n \n constructor(p1) {\n }\n}\nvar foo = 123;\n```\n\n| First Header | Second Header |\n| ------------- | ------------- |\n| Content Cell | Content Cell |\n| Content Cell | Content Cell |\n\n**text**\n\n~~text~~\n\n# text\n## text\n### text\n#### text\n##### text\n"
},
{
"path": "esdoc-standard-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"index\": \"./test/README.md\",\n \"package\": \"./test/package.json\",\n \"plugins\": [\n {\n \"name\": \"./src/Plugin.js\",\n \"option\": {\n \"brand\": {\n \"title\": \"My Library\"\n },\n \"manual\": {\n \"files\": [\"./test/manual/overview.md\"]\n },\n \"test\": {\n \"source\": \"./test/test\",\n \"includes\": [\"Test.js$\"]\n }\n }\n },\n {\n \"name\": \"./test/spy-plugin.js\"\n }\n ]\n}\n"
},
{
"path": "esdoc-standard-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-standard-plugin/test/manual/overview.md",
"content": "# This is Overview\nfixture\n"
},
{
"path": "esdoc-standard-plugin/test/package.json",
"content": "{\n \"name\": \"esdoc-test-fixture\",\n \"version\": \"1.2.3\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc\"\n },\n \"main\": \"./src/Class/Definition.js\"\n}\n"
},
{
"path": "esdoc-standard-plugin/test/spy-plugin.js",
"content": "exports.onHandlePlugins = function(ev) {\n exports.testTargetPlugins = ev.data.plugins;\n};\n\n"
},
{
"path": "esdoc-standard-plugin/test/src/MyClass.js",
"content": "export default class MyClass {\n /**\n * this is invalid param name.\n * @param xxx\n */\n invalidMeethod(p){}\n\n /**\n * @param {number} p\n */\n method1(p){}\n\n /**\n * @protected\n */\n method2(){}\n\n /**\n * @private\n */\n method3(){}\n\n _method4(p = 1){}\n}\n"
},
{
"path": "esdoc-standard-plugin/test/src/Plugin.test.js",
"content": "const assert = require('assert');\nconst path = require('path');\n\ndescribe('test standard plugin:', ()=>{\n it('dynamically load plugins', ()=>{\n const plugins = require('../spy-plugin.js').testTargetPlugins;\n\n assert.deepEqual(plugins, [\n {name: './src/Plugin.js', option: {\n brand: {\n title: 'My Library'\n },\n manual: {\n files: ['./test/manual/overview.md']\n },\n test: {\n source: \"./test/test\",\n includes: [\"Test.js$\"]\n }\n }},\n {name: './test/spy-plugin.js'},\n {name: 'esdoc-lint-plugin'},\n {name: 'esdoc-coverage-plugin'},\n {name: 'esdoc-accessor-plugin'},\n {name: 'esdoc-type-inference-plugin'},\n {name: 'esdoc-external-ecmascript-plugin'},\n {name: 'esdoc-brand-plugin', option: {title: 'My Library'}},\n {name: 'esdoc-undocumented-identifier-plugin'},\n {name: 'esdoc-unexported-identifier-plugin'},\n {name: 'esdoc-integrate-manual-plugin', option: {\n coverage: true,\n files: ['./test/manual/overview.md']\n }},\n {name: 'esdoc-integrate-test-plugin', option: {\n source: \"./test/test\",\n interfaces: [\"describe\", \"it\", \"context\", \"suite\", \"test\"],\n includes: [\"Test.js$\"],\n excludes: [\"\\\\.config\\\\.js$\"]\n }},\n {name: 'esdoc-publish-html-plugin'},\n ]);\n\n });\n});\n"
},
{
"path": "esdoc-standard-plugin/test/test/MyClassTest.js",
"content": "const assert = require('assert');\nconst MyClass = require('../src/MyClass');\n\n/**\n * @test {MyClass}\n */\ndescribe('MyClass', ()=>{\n it('has MyClass', ()=>{\n assert(MyClass)\n });\n});\n"
},
{
"path": "esdoc-type-inference-plugin/CHANGELOG.md",
"content": "# Changelog\n\n## Next\n- **Fix**\n - Crash if `export default foo = new Foo()` ([#55](https://github.com/esdoc/esdoc-plugins/pull/55)). Thanks [@ushu](https://github.com/ushu)\n\n## 1.0.1 (2017-09-03)\n- **Fix**\n - Broken if array sparse destructuring ([esdoc/esdoc#394](https://github.com/esdoc/esdoc/pull/394)) Thanks [@technicallyfeasible](https://github.com/technicallyfeasible)\n\n## 1.0.0 (2017-07-30)\n- Release\n"
},
{
"path": "esdoc-type-inference-plugin/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2015 Ryo Maruyama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "esdoc-type-inference-plugin/README.md",
"content": "# ESDoc Type Inference Plugin(PoC)\n**This is Proof of Concept**\n## Install\n```bash\nnpm install esdoc-type-inference-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\"name\": \"esdoc-type-inference-plugin\", \"option\": {\"enable\": true}}\n ]\n}\n```\n\n- `enable` is default `true`\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-type-inference-plugin/package.json",
"content": "{\n \"name\": \"esdoc-type-inference-plugin\",\n \"version\": \"1.0.1\",\n \"description\": \"A type inference plugin for ESDoc [PoC]\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"inference\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-type-inference-plugin/src/Plugin.js",
"content": "const ASTNodeContainer = require('esdoc/out/src/Util/ASTNodeContainer.js').default;\nconst ASTUtil = require('esdoc/out/src/Util/ASTUtil').default;\n\nclass Plugin {\n onHandleDocs(ev) {\n this._docs = ev.data.docs;\n this._option = ev.data.option || {};\n\n if (!('enable' in this._option)) this._option.enable = true;\n\n this._exec();\n }\n\n _exec() {\n if (!this._option.enable) return this._docs;\n\n this._inferenceMethod();\n this._inferenceFunction();\n this._inferenceGetter();\n this._inferenceSetter();\n this._inferenceMember();\n this._inferenceVariable();\n }\n\n _inferenceMethod() {\n const docs = this._docs.filter((doc) => doc.kind === 'method');\n\n for (const doc of docs) {\n const node = ASTNodeContainer.getNode(doc.__docId__);\n if (!doc.params) doc.params = this._inferenceParam(node);\n if (!doc.return) doc.return = this._inferenceReturn(node);\n }\n }\n\n _inferenceFunction() {\n const docs = this._docs.filter((doc) => doc.kind === 'function');\n\n for (const doc of docs) {\n const node = ASTNodeContainer.getNode(doc.__docId__);\n if (!doc.params) doc.params = this._inferenceParam(node);\n if (!doc.return) doc.return = this._inferenceReturn(node);\n }\n }\n\n _inferenceGetter() {\n const docs = this._docs.filter((doc) => doc.kind === 'get');\n\n for (const doc of docs) {\n const node = ASTNodeContainer.getNode(doc.__docId__);\n if (!doc.type) doc.type = this._inferenceReturn(node);\n }\n }\n\n _inferenceSetter() {\n // todo: infer setter is not working. please implement inference.\n // const docs = this._docs.filter((doc) => doc.kind === 'set');\n //\n // for (const doc of docs) {\n // const node = ASTNodeContainer.getNode(doc.__docId__);\n // if (!doc.type) doc.type = this._inferenceType(node.right);\n // }\n }\n\n _inferenceMember() {\n const docs = this._docs.filter((doc) => doc.kind === 'member');\n\n for (const doc of docs) {\n const node = ASTNodeContainer.getNode(doc.__docId__);\n if (!doc.type) doc.type = this._inferenceType(node.right);\n }\n }\n\n _inferenceVariable() {\n const docs = this._docs.filter((doc) => doc.kind === 'variable');\n\n for (const doc of docs) {\n if (doc.type) continue;\n\n const node = ASTNodeContainer.getNode(doc.__docId__);\n\n let className;\n\n // e.g. `export default foo = new Foo();`\n if (node.type === 'AssignmentExpression') {\n if (node.right && node.right.type === 'NewExpression') {\n className = node.right.callee.name;\n } else {\n doc.type = this._inferenceType(node.right);\n continue;\n }\n }\n\n // e.g. `let foo = new Foo();`\n if (node.type === 'VariableDeclaration') {\n if (node.declarations[0].init.type === 'NewExpression') {\n className = node.declarations[0].init.callee.name;\n } else {\n doc.type = this._inferenceType(node.declarations[0].init);\n continue;\n }\n }\n\n // can not infer className\n if (!className) {\n doc.type = {types: ['*']};\n continue;\n }\n\n if (className) {\n // infer from same file.\n const classDoc = this._docs.find((_doc) =>{\n if (_doc.kind === 'class' && _doc.memberof === doc.memberof && _doc.name === className) {\n return true;\n }\n });\n if (classDoc) {\n doc.type = {types: [classDoc.longname]};\n continue;\n }\n\n // ambiguous infer from other file\n const ambiguousClassDocs = this._docs.filter((_doc) => {\n if (_doc.kind === 'class' && _doc.name === className) {\n return true;\n }\n });\n if (ambiguousClassDocs.length === 1) {\n doc.type = {types: [ambiguousClassDocs[0].longname]};\n continue;\n }\n\n // can not infer\n doc.type = {types: ['*']};\n } else {\n doc.type = {types: ['*']};\n }\n }\n }\n\n _inferenceParam(node) {\n const params = node.params;\n const _params = [];\n for (let i = 0; i < params.length; i++) {\n const param = params[i];\n const result = {};\n\n switch (param.type) {\n case 'Identifier':\n // e.g. func(a){}\n result.name = param.name;\n result.types = ['*'];\n break;\n\n case 'AssignmentPattern':\n if (param.left.type === 'Identifier') {\n result.name = param.left.name;\n } else if (param.left.type === 'ObjectPattern') {\n result.name = `objectPattern${i === 0 ? '' : i}`;\n } else if (param.left.type === 'ArrayPattern') {\n result.name = `arrayPattern${i === 0 ? '' : i}`;\n }\n\n result.optional = true;\n\n if (param.right.type.includes('Literal')) {\n // e.g. func(a = 10){}\n result.types = param.right.value === null ? ['*'] : [typeof param.right.value];\n result.defaultRaw = param.right.value;\n result.defaultValue = `${result.defaultRaw}`;\n } else if (param.right.type === 'ArrayExpression') {\n // e.g. func(a = [123]){}\n result.types = param.right.elements.length ? [`${typeof param.right.elements[0].value}[]`] : ['*[]'];\n result.defaultRaw = param.right.elements.map((elm)=> elm.value);\n result.defaultValue = `${JSON.stringify(result.defaultRaw)}`;\n } else if (param.right.type === 'ObjectExpression') {\n const typeMap = {};\n for (const prop of param.left.properties || []) {\n typeMap[prop.key.name] = '*';\n }\n\n // e.g. func(a = {key: 123}){}\n const obj = {};\n for (const prop of param.right.properties) {\n obj[prop.key.name] = prop.value.value;\n typeMap[prop.key.name] = typeof prop.value.value;\n }\n\n const types = [];\n for (const key of Object.keys(typeMap)) {\n types.push(`\"${key}\": ${typeMap[key]}`);\n }\n\n result.types = [`{${types.join(', ')}}`];\n result.defaultRaw = obj;\n result.defaultValue = `${JSON.stringify(result.defaultRaw)}`;\n } else if (param.right.type === 'Identifier') {\n // e.g. func(a = value){}\n result.types = ['*'];\n result.defaultRaw = param.right.name;\n result.defaultValue = `${param.right.name}`;\n } else {\n // e.g. func(a = new Foo()){}, func(a = foo()){}\n // CallExpression, NewExpression\n result.types = ['*'];\n }\n break;\n case 'RestElement':\n // e.g. func(...a){}\n result.name = `${param.argument.name}`;\n result.types = ['...*'];\n result.spread = true;\n break;\n case 'ObjectPattern': {\n const objectPattern = [];\n const raw = {};\n for (const property of param.properties) {\n if (property.type === 'ObjectProperty') {\n objectPattern.push(`\"${property.key.name}\": *`);\n raw[property.key.name] = null;\n } else if (property.type === 'RestProperty') {\n objectPattern.push(`...${property.argument.name}: Object`);\n raw[property.argument.name] = {};\n }\n }\n result.name = `objectPattern${i === 0 ? '' : i}`;\n result.types = [`{${objectPattern.join(', ')}}`];\n result.defaultRaw = raw;\n result.defaultValue = `${JSON.stringify(result.defaultRaw)}`;\n break;\n }\n case 'ArrayPattern': {\n // e.g. func([a, b = 10]){}\n let arrayType = null;\n const raw = [];\n\n for (const element of param.elements) {\n if (!element) { // case `function([, v]){}\n raw.push('undefined');\n } else if (element.type === 'Identifier') {\n raw.push('null');\n } else if (element.type === 'AssignmentPattern') {\n if ('value' in element.right) {\n if (!arrayType && element.right.value !== null) arrayType = typeof element.right.value;\n raw.push(JSON.stringify(element.right.value));\n } else {\n raw.push('*');\n }\n }\n }\n\n if (!arrayType) arrayType = '*';\n result.name = `arrayPattern${i === 0 ? '' : i}`;\n result.types = [`${arrayType}[]`];\n result.defaultRaw = raw;\n result.defaultValue = `[${raw.join(', ')}]`;\n break;\n }\n default:\n logger.w('unknown param.type', param);\n }\n\n _params.push(result);\n }\n\n return _params;\n }\n\n _inferenceReturn(node) {\n const body = node.body;\n const result = {};\n const inferenceType = this._inferenceType.bind(this);\n\n ASTUtil.traverse(body, (node, parent, path)=>{\n // `return` in Function is not the body's `return`\n if (node.type.includes('Function')) {\n path.skip();\n return;\n }\n\n if (node.type !== 'ReturnStatement') return;\n\n if (!node.argument) return;\n\n result.types = inferenceType(node.argument).types;\n });\n\n if (result.types) {\n return result;\n }\n\n return null;\n }\n\n _inferenceType(right) {\n if (!right) {\n return {types: ['*']};\n }\n\n if (right.type === 'TemplateLiteral') {\n return {types: ['string']};\n }\n\n if (right.type === 'NullLiteral') {\n return {types: ['*']};\n }\n\n if (right.type.includes('Literal')) {\n return {types: [typeof right.value]};\n }\n\n if (right.type === 'ArrayExpression') {\n if (right.elements.length) {\n return {types: [`${typeof right.elements[0].value}[]`]};\n } else {\n return {types: ['*[]']};\n }\n }\n\n if (right.type === 'ObjectExpression') {\n const typeMap = {};\n for (const prop of right.properties) {\n switch (prop.type) {\n case 'ObjectProperty': {\n const name = `\"${prop.key.name || prop.key.value}\"`;\n typeMap[name] = prop.value.value ? typeof prop.value.value : '*';\n break;\n }\n case 'ObjectMethod': {\n const name = `\"${prop.key.name || prop.key.value}\"`;\n typeMap[name] = 'function';\n break;\n }\n case 'SpreadProperty': {\n const name = `...${prop.argument.name}`;\n typeMap[name] = 'Object';\n break;\n }\n default: {\n const name = `\"${prop.key.name || prop.key.value}\"`;\n typeMap[name] = '*';\n }\n }\n }\n\n const types = [];\n for (const key of Object.keys(typeMap)) {\n types.push(`${key}: ${typeMap[key]}`);\n }\n\n return {types: [`{${types.join(', ')}}`]};\n }\n\n return {types: ['*']};\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-type-inference-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"plugins\": [\n {\"name\": \"./src/Plugin.js\"}\n ]\n}\n"
},
{
"path": "esdoc-type-inference-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Getter.js",
"content": "export default class TestGetter {\n get getLiteral () {\n return 123;\n }\n\n get getArray () {\n return [123, 456];\n }\n\n get getObject() {\n return {x1: 123, x2: 'text'};\n }\n\n get getTemplateLiteral() {\n return `text`;\n }\n}\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Getter.test.js",
"content": "const assert = require('assert');\nconst {find} = require('../util');\n\ndescribe('test/Getter.js:', ()=>{\n it('infer type that is literal', ()=>{\n const doc = find('longname', 'src/Getter.js~TestGetter#getLiteral');\n assert.deepEqual(doc.type, {types: ['number']});\n });\n\n it('infer type that is array', ()=>{\n const doc = find('longname', 'src/Getter.js~TestGetter#getArray');\n assert.deepEqual(doc.type, {types: ['number[]']});\n });\n\n it('infer type that is object', ()=>{\n const doc = find('longname', 'src/Getter.js~TestGetter#getObject');\n assert.deepEqual(doc.type, {types: ['{\"x1\": number, \"x2\": string}']});\n });\n\n it('infer type that is template literal', ()=>{\n const doc = find('longname', 'src/Getter.js~TestGetter#getTemplateLiteral');\n assert.deepEqual(doc.type, {types: ['string']});\n });\n});\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Member.js",
"content": "export default class TestMember {\n constructor() {\n // literal\n this.memberLiteral = 123;\n\n // array\n this.memberArray = [123, 456];\n\n // object\n this.memberObject = {x1: 123, x2: 'text'};\n\n // template literal\n this.memberTemplateLiteral= `text`;\n }\n}\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Member.test.js",
"content": "const assert = require('assert');\nconst {find} = require('../util');\n\ndescribe('test/Member.js:', ()=>{\n it('infer type that is literal', ()=>{\n const doc = find('longname', 'src/Member.js~TestMember#memberLiteral');\n assert.deepEqual(doc.type, {types: ['number']});\n });\n\n it('infer type that is array', ()=>{\n const doc = find('longname', 'src/Member.js~TestMember#memberArray');\n assert.deepEqual(doc.type, {types: ['number[]']});\n });\n\n it('infer type that is object', ()=>{\n const doc = find('longname', 'src/Member.js~TestMember#memberObject');\n assert.deepEqual(doc.type, {types: ['{\"x1\": number, \"x2\": string}']});\n });\n\n it('infer type that is template literal', ()=>{\n const doc = find('longname', 'src/Member.js~TestMember#memberTemplateLiteral');\n assert.deepEqual(doc.type, {types: ['string']});\n });\n});\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Param.js",
"content": "export default class TestParam {\n // literal default\n methodLiteral(p1 = 123){}\n\n // identifier default\n methodIdentifier(p1 = value){}\n\n // new expression default\n methodNewExpression(p1 = new Foo()){}\n\n // array default\n methodArray(p1 = [123, 456]){}\n\n // array destructuring\n methodArrayDestructuring([p1, p2]){}\n\n // array default and destructuring\n methodArrayAndDestructuring([p1, p2] = [123, 456]){}\n\n // sparse array destructuring\n methodArraySparseDestructuring([, p2]) {}\n\n // object default\n methodObject(p1 = {x1: \"text\", x2: true}){}\n\n // object destructuring\n methodObjectDestructuring({x1, x2}){}\n\n // object default and destructuring\n methodObjectAndDestructuring({x1, x2} = {x1: 123, x2: \"text\"}){}\n\n // spread\n methodSpread(...p1){}\n\n // array destructuring and partial default\n methodArrayDestructuringAndPartialDefault([p1, p2 = 10, p3 = null, p4 = 'text', p5 = v]){}\n}\n\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Param.test.js",
"content": "const assert = require('assert');\nconst {find} = require('../util');\n\ndescribe('test/Param.js:', ()=> {\n it('infer literal param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodLiteral');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"p1\",\n \"optional\": true,\n \"types\": [\n \"number\"\n ],\n \"defaultRaw\": 123,\n \"defaultValue\": \"123\"\n }\n ]);\n });\n\n it('infer identifier param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodIdentifier');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"p1\",\n \"optional\": true,\n \"types\": [\n \"*\"\n ],\n \"defaultRaw\": \"value\",\n \"defaultValue\": \"value\"\n }\n ]);\n });\n\n it('infer new expression param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodNewExpression');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"p1\",\n \"optional\": true,\n \"types\": [\n \"*\"\n ]\n }\n ]);\n });\n\n it('infer array param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodArray');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"p1\",\n \"optional\": true,\n \"types\": [\n \"number[]\"\n ],\n \"defaultRaw\": [\n 123,\n 456\n ],\n \"defaultValue\": \"[123,456]\"\n }\n ]);\n });\n\n it('infer array destructuring param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodArrayDestructuring');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"arrayPattern\",\n \"types\": [\n \"*[]\"\n ],\n \"defaultRaw\": [\n \"null\",\n \"null\"\n ],\n \"defaultValue\": \"[null, null]\"\n }\n ]);\n });\n\n it('infer array default and destructuring param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodArrayAndDestructuring');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"arrayPattern\",\n \"optional\": true,\n \"types\": [\n \"number[]\"\n ],\n \"defaultRaw\": [\n 123,\n 456\n ],\n \"defaultValue\": \"[123,456]\"\n }\n ]);\n });\n\n it('infer array sparse destructuring param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodArraySparseDestructuring');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"arrayPattern\",\n \"types\": [\n \"*[]\"\n ],\n \"defaultRaw\": [\n 'undefined',\n 'null'\n ],\n \"defaultValue\": \"[undefined, null]\"\n }\n ]);\n });\n\n it('infer object param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodObject');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"p1\",\n \"optional\": true,\n \"types\": [\n \"{\\\"x1\\\": string, \\\"x2\\\": boolean}\"\n ],\n \"defaultRaw\": {\n \"x1\": \"text\",\n \"x2\": true\n },\n \"defaultValue\": \"{\\\"x1\\\":\\\"text\\\",\\\"x2\\\":true}\"\n }\n ]);\n });\n\n it('infer object destructuring param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodObjectDestructuring');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"objectPattern\",\n \"types\": [\n \"{\\\"x1\\\": *, \\\"x2\\\": *}\"\n ],\n \"defaultRaw\": {\n \"x1\": null,\n \"x2\": null\n },\n \"defaultValue\": \"{\\\"x1\\\":null,\\\"x2\\\":null}\"\n }\n ]);\n });\n\n it('infer object default and destructuring param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodObjectAndDestructuring');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"objectPattern\",\n \"optional\": true,\n \"types\": [\n \"{\\\"x1\\\": number, \\\"x2\\\": string}\"\n ],\n \"defaultRaw\": {\n \"x1\": 123,\n \"x2\": \"text\"\n },\n \"defaultValue\": \"{\\\"x1\\\":123,\\\"x2\\\":\\\"text\\\"}\"\n }\n ]);\n });\n\n it('infer spread param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodSpread');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"p1\",\n \"types\": [\n \"...*\"\n ],\n \"spread\": true\n }\n ]);\n });\n\n it('infer array destructuring and partial default param', ()=>{\n const doc = find('longname', 'src/Param.js~TestParam#methodArrayDestructuringAndPartialDefault');\n assert.deepEqual(doc.params, [\n {\n \"name\": \"arrayPattern\",\n \"types\": [\n \"number[]\"\n ],\n \"defaultRaw\": [\n \"null\",\n \"10\",\n \"*\",\n \"\\\"text\\\"\",\n \"*\"\n ],\n \"defaultValue\": \"[null, 10, *, \\\"text\\\", *]\"\n }\n ]);\n });\n});\n\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Return.js",
"content": "export default class TestReturn {\n // literal\n methodLiteral(){\n return 123;\n }\n\n // array\n methodArray(){\n return [123, 456];\n }\n\n // object\n methodObject(){\n return {x1: 123, x2: 'text'};\n }\n\n // template literal\n methodTemplateLiteral(){\n return `text`;\n }\n}\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Return.test.js",
"content": "const assert = require('assert');\nconst {find} = require('../util');\n\ndescribe('test/Return.js:', ()=>{\n it('infer return value that is literal', ()=>{\n const doc = find('longname', 'src/Return.js~TestReturn#methodLiteral');\n assert.deepEqual(doc.return, {types: ['number']});\n });\n\n it('infer return value that is array', ()=>{\n const doc = find('longname', 'src/Return.js~TestReturn#methodArray');\n assert.deepEqual(doc.return, {types: ['number[]']});\n });\n\n it('infer return value that is object', ()=>{\n const doc = find('longname', 'src/Return.js~TestReturn#methodObject');\n assert.deepEqual(doc.return, {types: ['{\"x1\": number, \"x2\": string}']});\n });\n\n it('infer return value that is template literal', ()=>{\n const doc = find('longname', 'src/Return.js~TestReturn#methodTemplateLiteral');\n assert.deepEqual(doc.return, {types: ['string']});\n });\n});\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Variable.js",
"content": "// literal\nexport const testVariableLiteral = 123;\n\n// array\nexport const testVariableArray = [123, 456];\n\n// object\nexport const testVariableObject = {x1: 123, x2: \"text\"};\n\n// template literal\nexport const testVariableTemplateLiteral = `text`;\n\n// new expression with same file\nexport class TestVariableNewExpression {}\nexport default new TestVariableNewExpression();\n\n// new expression with other file\nimport TestMember from './Member';\nexport const testVariableNewExpressionOtherFile = new TestMember();\n"
},
{
"path": "esdoc-type-inference-plugin/test/src/Variable.test.js",
"content": "const assert = require('assert');\nconst {find} = require('../util');\n\ndescribe('test/Variable.js:', ()=>{\n it('infer type that is literal', ()=>{\n const doc = find('longname', 'src/Variable.js~testVariableLiteral');\n assert.deepEqual(doc.type, {types: ['number']});\n });\n\n it('infer type that is array', ()=>{\n const doc = find('longname', 'src/Variable.js~testVariableArray');\n assert.deepEqual(doc.type, {types: ['number[]']});\n });\n\n it('infer type that is object', ()=>{\n const doc = find('longname', 'src/Variable.js~testVariableObject');\n assert.deepEqual(doc.type, {types: ['{\"x1\": number, \"x2\": string}']});\n });\n\n it('infer type that is template literal', ()=>{\n const doc = find('longname', 'src/Variable.js~testVariableTemplateLiteral');\n assert.deepEqual(doc.type, {types: ['string']});\n });\n\n it('infer type that is new expression with same file', ()=>{\n const doc = find('longname', 'src/Variable.js~testVariableNewExpression');\n assert.deepEqual(doc.type, {types: ['src/Variable.js~TestVariableNewExpression']});\n });\n\n it('infer type that is new expression with other file', ()=>{\n const doc = find('longname', 'src/Variable.js~testVariableNewExpressionOtherFile');\n assert.deepEqual(doc.type, {types: ['src/Member.js~TestMember']});\n });\n});\n"
},
{
"path": "esdoc-type-inference-plugin/test/util.js",
"content": "exports.find = function(key, ...values) {\n if (values.length === 1) {\n return global.docs.find((doc) => {\n if (typeof values[0] === 'string') return doc[key] === values[0];\n if (values[0] instanceof RegExp) return doc[key].match(values[0]);\n });\n }\n\n const results = [];\n for (const value of values) {\n const result = global.docs.find(doc => {\n if (typeof value === 'string') return doc[key] === value;\n if (value instanceof RegExp) return doc[key].match(value);\n });\n\n results.push(result);\n }\n\n return results;\n};\n"
},
{
"path": "esdoc-typescript-plugin/CHANGELOG.md",
"content": "# Changelog\n\n## Next\n- **Fix**\n - Crash if overload methods ([#42](https://github.com/esdoc/esdoc-plugins/pull/42)). Thanks [@tchakabam](https://github.com/tchakabam)\n- **Chore**\n - Update typescript\n\n## 1.0.0 (2017-07-30)\n- Release\n"
},
{
"path": "esdoc-typescript-plugin/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2015 Ryo Maruyama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "esdoc-typescript-plugin/README.md",
"content": "# ESDoc TypeScript Plugin (PoC)\n**This plugin is proof of concept**\n\n## Install\n```bash\nnpm install esdoc-typescript-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\"name\": \"esdoc-typescript-plugin\", \"option\": {\"enable\": true}}\n ]\n}\n```\n\n- `enable` is default `true`\n\n## Example\n```js\nexport class Foo {\n // without document, with initializer\n member: number = 10;\n \n // without document\n method1(n: number): string {\n }\n \n // without @param and @return\n /**\n * this is method2.\n */\n method2(n: number): string {\n }\n \n // without type in @param and @return\n /**\n * this is method3.\n * @param n - this is param desc.\n * @return this is return desc. \n */\n method3(n: number): string {\n }\n}\n```\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-typescript-plugin/package.json",
"content": "{\n \"name\": \"esdoc-typescript-plugin\",\n \"version\": \"1.0.0\",\n \"description\": \"A TypeScript plugin for ESDoc [PoC]\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"dependencies\": {\n \"typescript\": \"^2.8.3\"\n },\n \"devDependencies\": {\n \"esdoc\": \"^1.1.0\",\n \"esdoc-standard-plugin\": \"^1.0.0\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"typescript\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-typescript-plugin/src/Plugin.js",
"content": "const path = require('path');\nconst ts = require('typescript');\nconst CommentParser = require('esdoc/out/src/Parser/CommentParser').default;\n\nclass Plugin {\n constructor() {\n this._enable = true;\n }\n\n onStart(ev) {\n if (!ev.data.option) return;\n if ('enable' in ev.data.option) this._enable = ev.data.option.enable;\n }\n\n onHandleConfig(ev) {\n if (!this._enable) return;\n\n if (!ev.data.config.includes) ev.data.config.includes = [];\n ev.data.config.includes.push('\\\\.ts$', '\\\\.js$');\n }\n\n onHandleCodeParser(ev) {\n if (!this._enable) return;\n\n const esParser = ev.data.parser;\n const esParserOption = ev.data.parserOption;\n const filePath = ev.data.filePath;\n\n // ev.data.parser = this._tsParser.bind(this, esParser, esParserOption, filePath);\n\n ev.data.parser = (code) =>{\n try {\n return this._tsParser(esParser, esParserOption, filePath, code);\n } catch(e) {\n console.log(e)\n }\n };\n }\n\n // https://github.com/Microsoft/TypeScript/blob/master/src/services/transpile.ts#L26\n _tsParser(esParser, esParserOption, filePath, code) {\n // return if not typescript\n if (path.extname(filePath) !== '.ts') return esParser(code);\n\n // create ast and get target nodes\n const sourceFile = ts.createSourceFile(filePath, code, ts.ScriptTarget.Latest, true);\n const nodes = this._getTargetTSNodes(sourceFile);\n\n // rewrite jsdoc comment\n nodes.sort((a,b) => b.pos - a.pos); // hack: transpile comment with reverse\n const codeChars = [...code];\n for (const node of nodes) {\n const jsDocNode = this._getJSDocNode( node);\n if (jsDocNode && jsDocNode.comment) codeChars.splice(jsDocNode.pos, jsDocNode.end - jsDocNode.pos);\n\n const newComment = this._transpileComment(node, jsDocNode ? jsDocNode.comment : '', code);\n codeChars.splice(node.pos, 0, newComment);\n }\n const newTSCode = codeChars.join('');\n\n // transpile typescript to es\n const esCode = this._transpileTS2ES(newTSCode);\n\n return esParser(esCode);\n }\n\n _getTargetTSNodes(sourceFile) {\n const nodes = [];\n walk(sourceFile);\n return nodes;\n\n function walk(node) {\n switch (node.kind) {\n case ts.SyntaxKind.ClassDeclaration:\n case ts.SyntaxKind.MethodDeclaration:\n case ts.SyntaxKind.PropertyDeclaration:\n case ts.SyntaxKind.GetAccessor:\n case ts.SyntaxKind.SetAccessor:\n case ts.SyntaxKind.FunctionDeclaration:\n nodes.push(node);\n break;\n }\n\n ts.forEachChild(node, walk);\n }\n }\n\n _getJSDocNode(node) {\n if (!node.jsDoc) return null;\n\n return node.jsDoc[node.jsDoc.length - 1];\n }\n\n _transpileComment(node, comment, code) {\n const esNode = {type: 'CommentBlock', value: `*\\n${comment}`};\n const tags = CommentParser.parse(esNode);\n\n this._applyLOC(node, tags, code);\n\n switch(node.kind) {\n case ts.SyntaxKind.ClassDeclaration:\n // do nothing\n break;\n case ts.SyntaxKind.MethodDeclaration:\n this._applyCallableParam(node, tags);\n this._applyCallableReturn(node, tags);\n break;\n case ts.SyntaxKind.PropertyDeclaration:\n this._applyClassProperty(node, tags);\n break;\n case ts.SyntaxKind.GetAccessor:\n this._applyClassMethodGetter(node, tags);\n break;\n case ts.SyntaxKind.SetAccessor:\n this._applyClassMethodSetter(node, tags);\n break;\n case ts.SyntaxKind.FunctionDeclaration:\n this._applyCallableParam(node, tags);\n this._applyCallableReturn(node, tags);\n break;\n }\n\n return `\\n/*${CommentParser.buildComment(tags)} */\\n`;\n }\n\n _applyLOC(node, tags, code) {\n let loc = 1;\n const codeChars = [...code];\n for (let i = 0; i < node.name.end; i++) {\n if (codeChars[i] === '\\n') loc++;\n }\n tags.push({tagName: '@lineNumber', tagValue: `${loc}`});\n }\n\n _applyCallableParam(node, tags) {\n const types = node.parameters.map(param => {\n return {\n type: this._getTypeFromAnnotation(param.type),\n name: param.name.text\n };\n });\n\n const paramTags = tags.filter(tag => tag.tagName === '@param');\n\n // merge\n // case: params without comments\n if (paramTags.length === 0 && types.length) {\n const tmp = types.map(({type, name}) => {\n return {\n tagName: '@param',\n tagValue: `{${type}} ${name}`\n };\n });\n tags.push(...tmp);\n return;\n }\n\n // case: params with comments\n if (paramTags.length === types.length) {\n for (let i = 0; i < paramTags.length; i++) {\n const paramTag = paramTags[i];\n const type = types[i];\n if (paramTag.tagValue.charAt(0) !== '{') { // does not have type\n paramTag.tagValue = `{${type.type}} ${paramTag.tagValue}`;\n }\n }\n return;\n }\n\n // case: mismatch params and comments\n throw new Error('mismatch params and comments');\n }\n\n _applyCallableReturn(node, tags) {\n if (!node.type) return;\n\n // get type\n const type = this._getTypeFromAnnotation(node.type);\n if (!type) return;\n\n // get comments\n const returnTag = tags.find(tag => tag.tagName === '@return' || tag.tagName === '@returns');\n\n // merge\n if (returnTag && returnTag.tagValue.charAt(0) !== '{') { // return with comment but does not have type\n returnTag.tagValue = `{${type}} ${returnTag.tagValue}`;\n } else {\n tags.push({tagName: '@return', tagValue: `{${type}}`});\n }\n }\n\n _applyClassMethodGetter(node, tags) {\n if (!node.type) return;\n\n // get type\n const type = this._getTypeFromAnnotation(node.type);\n if (!type) return;\n\n // get comments\n const typeComment = tags.find(tag => tag.tagName === '@type');\n\n if (typeComment && typeComment.tagValue.charAt(0) !== '{') { // type with comment but does not have tpe\n typeComment.tagValue = `{${type}}`;\n } else {\n tags.push({tagName: '@type', tagValue: `{${type}}`});\n }\n }\n\n _applyClassMethodSetter(node, tags) {\n if (!node.parameters) return;\n\n // get type\n const type = this._getTypeFromAnnotation(node.parameters[0].type);\n if (!type) return;\n\n // get comment\n const typeComment = tags.find(tag => tag.tagName === '@type');\n if (typeComment) return;\n\n // merge\n // case: param without comment\n tags.push({tagName: '@type', tagValue: `{${type}}`});\n }\n\n _applyClassProperty(node, tags) {\n if (!node.type) return;\n\n // get type\n const type = this._getTypeFromAnnotation(node.type);\n if (!type) return;\n\n // get comments\n const typeComment = tags.find(tag => tag.tagName === '@type');\n\n if (typeComment && typeComment.tagValue.charAt(0) !== '{') { // type with comment but does not have tpe\n typeComment.tagValue = `{${type}}`;\n } else {\n tags.push({tagName: '@type', tagValue: `{${type}}`});\n }\n }\n\n _getTypeFromAnnotation(typeNode) {\n if (!typeNode) {\n return 'undefined';\n }\n\n switch(typeNode.kind) {\n case ts.SyntaxKind.NumberKeyword: return 'number';\n case ts.SyntaxKind.StringKeyword: return 'string';\n case ts.SyntaxKind.BooleanKeyword: return 'boolean';\n case ts.SyntaxKind.TypeReference: return typeNode.typeName.text;\n }\n }\n\n _transpileTS2ES(tsCode) {\n // todo\n const esOption = {\n decorators: true,\n jsx: true,\n };\n const options = {\n module: ts.ModuleKind.ES2015,\n noResolve: true,\n target: ts.ScriptTarget.Latest,\n experimentalDecorators: esOption.decorators,\n jsx: esOption.jsx ? 'preserve' : undefined,\n };\n\n const result = ts.transpileModule(tsCode, {compilerOptions: options});\n return result.outputText;\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-typescript-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js\"],\n \"plugins\": [\n {\"name\": \"./src/Plugin.js\"},\n {\"name\": \"esdoc-standard-plugin\"}\n ]\n}\n"
},
{
"path": "esdoc-typescript-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-typescript-plugin/test/src/TypeScript.test.js",
"content": "const assert = require('assert');\nconst {find, file} = require('../util');\n\ndescribe('test/TypeScript.js:', ()=> {\n it('has type of method, without comment', ()=>{\n const doc = find('longname', 'src/TypeScript.ts~TestTypeScriptClass#method1');\n\n assert.equal(doc.params.length, 2);\n assert.deepEqual(doc.params[0].types, ['number']);\n assert.deepEqual(doc.params[1].types, ['Foo']);\n\n assert.deepEqual(doc.return.types, ['string']);\n });\n\n it('has type of method, without tags', ()=>{\n const doc = find('longname', 'src/TypeScript.ts~TestTypeScriptClass#method2');\n assert.equal(doc.params.length, 2);\n assert.deepEqual(doc.params[0].types, ['number']);\n assert.deepEqual(doc.params[1].types, ['Foo']);\n\n assert.deepEqual(doc.return.types, ['string']);\n });\n\n it('has type of method, without type', ()=>{\n const doc = find('longname', 'src/TypeScript.ts~TestTypeScriptClass#method3');\n assert.equal(doc.params.length, 2);\n assert.deepEqual(doc.params[0].types, ['number']);\n assert.deepEqual(doc.params[1].types, ['Foo']);\n\n assert.deepEqual(doc.return.types, ['string']);\n });\n\n it('has type of getter, without comment', ()=>{\n const doc = find('longname', 'src/TypeScript.ts~TestTypeScriptClass#getter1');\n assert.deepEqual(doc.type.types, ['string']);\n });\n\n it('has type of setter, without comment', ()=>{\n const doc = find('longname', 'src/TypeScript.ts~TestTypeScriptClass#setter1');\n assert.deepEqual(doc.type.types, ['number']);\n });\n\n it('has type of member, without comment', ()=>{\n const doc = find('longname', 'src/TypeScript.ts~TestTypeScriptClass#member1');\n assert.deepEqual(doc.type.types, ['number']);\n });\n\n it('has type of function, without comment', ()=>{\n const doc = find('longname', 'src/TypeScript.ts~testTypeScriptFunction');\n\n assert.equal(doc.params.length, 2);\n assert.deepEqual(doc.params[0].types, ['number']);\n assert.deepEqual(doc.params[1].types, ['Foo']);\n\n assert.deepEqual(doc.return.types, ['string']);\n });\n});\n\n\n"
},
{
"path": "esdoc-typescript-plugin/test/src/TypeScript.ts",
"content": "/**\n * this is TestTypeScriptClass.\n */\nexport class TestTypeScriptClass {\n member1: number = null;\n\n get getter1(): string { return 'Hello'; }\n\n set setter1(v: number) {}\n\n method1(n: number, x: Foo): string {\n return 'Hello'.repeat(n);\n }\n\n /**\n * this is method2.\n */\n method2(n: number, x: Foo): string {\n return 'Hello'.repeat(n);\n }\n\n /**\n * this is method3.\n * @param n - this is n\n * @param x - this is x\n * @return this is return\n */\n method3(n: number, x: Foo): string {\n return 'Hello'.repeat(n);\n }\n}\n\nexport function testTypeScriptFunction(n: number, x: Foo): string{ return 'Hello'; }\n\nexport class Foo{}\n"
},
{
"path": "esdoc-typescript-plugin/test/util.js",
"content": "const fs = require('fs');\n\nexports.find = function(key, ...values) {\n if (values.length === 1) {\n return global.docs.find((doc) => {\n if (typeof values[0] === 'string') return doc[key] === values[0];\n if (values[0] instanceof RegExp) return doc[key].match(values[0]);\n });\n }\n\n const results = [];\n for (const value of values) {\n const result = global.docs.find(doc => {\n if (typeof value === 'string') return doc[key] === value;\n if (value instanceof RegExp) return doc[key].match(value);\n });\n\n results.push(result);\n }\n\n return results;\n};\n\nexports.file = function (filePath) {\n return fs.readFileSync(filePath).toString();\n};\n\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/CHANGELOG.md",
"content": "# Changelog\n\n## 1.0.0 (2017-07-30)\n- Release\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2015 Ryo Maruyama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/README.md",
"content": "# ESDoc Undocumented Identifier Plugin\n## Install\n```bash\nnpm install esdoc-undocumented-identifier-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\"name\": \"esdoc-undocumented-identifier-plugin\", \"option\": {\"enable\": true}}\n ]\n}\n```\n\n`enable` is default `true`.\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/package.json",
"content": "{\n \"name\": \"esdoc-undocumented-identifier-plugin\",\n \"version\": \"1.0.0\",\n \"description\": \"A undocumented identifier plugin for ESDoc\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"undocument\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/src/Plugin.js",
"content": "class Plugin {\n onHandleDocs(ev) {\n this._option = ev.data.option || {};\n if (!('enable' in this._option)) this._option.enable = true;\n\n const ignore = !this._option.enable;\n\n for (const doc of ev.data.docs) {\n if (doc.undocument === true && ignore && !('ignore' in doc)) {\n doc.ignore = ignore;\n }\n }\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"plugins\": [\n {\"name\": \"./src/Plugin.js\"}\n ]\n}\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/test/src/MyClass.js",
"content": "export class MyClass1 {\n}\n\n/**\n * this is desc\n * @ignore\n */\nexport class MyClass2 {\n}\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/test/src/MyClass.test.js",
"content": "const assert = require('assert');\nconst {find, file} = require('../util');\n\ndescribe('test undocumented identifier result:', ()=> {\n it('does not ignore undocumented identifier.', ()=>{\n const doc = find('name', 'MyClass1');\n assert.equal(doc.undocument, true);\n assert.equal(doc.ignore, undefined);\n });\n\n it('ignores documented identifier with @ignore.', ()=>{\n const doc = find('name', 'MyClass2');\n assert.equal(doc.undocument, undefined);\n assert.equal(doc.ignore, true);\n });\n});\n\n"
},
{
"path": "esdoc-undocumented-identifier-plugin/test/util.js",
"content": "const fs = require('fs');\n\nexports.find = function(key, ...values) {\n if (values.length === 1) {\n return global.docs.find((doc) => {\n if (typeof values[0] === 'string') return doc[key] === values[0];\n if (values[0] instanceof RegExp) return doc[key].match(values[0]);\n });\n }\n\n const results = [];\n for (const value of values) {\n const result = global.docs.find(doc => {\n if (typeof value === 'string') return doc[key] === value;\n if (value instanceof RegExp) return doc[key].match(value);\n });\n\n results.push(result);\n }\n\n return results;\n};\n\nexports.file = function (filePath) {\n return fs.readFileSync(filePath).toString();\n};\n\n"
},
{
"path": "esdoc-unexported-identifier-plugin/CHANGELOG.md",
"content": "# Changelog\n\n## 1.0.0 (2017-07-30)\n- Release\n"
},
{
"path": "esdoc-unexported-identifier-plugin/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2015 Ryo Maruyama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "esdoc-unexported-identifier-plugin/README.md",
"content": "# ESDoc Unexported Identifier Plugin\n## Install\n```bash\nnpm install esdoc-unexported-identifier-plugin\n```\n\n## Config\n```json\n{\n \"source\": \"./src\",\n \"destination\": \"./doc\",\n \"plugins\": [\n {\"name\": \"esdoc-unexported-identifier-plugin\", \"option\": {\"enable\": false}}\n ]\n}\n```\n\n`enable` is default `false`.\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n"
},
{
"path": "esdoc-unexported-identifier-plugin/package.json",
"content": "{\n \"name\": \"esdoc-unexported-identifier-plugin\",\n \"version\": \"1.0.0\",\n \"description\": \"A unexported identifier plugin for ESDoc\",\n \"author\": \"h13i32maru\",\n \"homepage\": \"https://github.com/esdoc/esdoc-plugins\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/esdoc/esdoc-plugins\"\n },\n \"devDependencies\": {\n \"esdoc\": \"latest\",\n \"mocha\": \"2.5.3\"\n },\n \"engines\": {\n \"node\": \">= 6.0.0\"\n },\n \"scripts\": {\n \"test\": \"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec\"\n },\n \"keywords\": [\n \"esdoc\",\n \"unexported\",\n \"plugin\"\n ],\n \"files\": [\n \"src\",\n \"README.md\"\n ],\n \"main\": \"src/Plugin.js\"\n}\n"
},
{
"path": "esdoc-unexported-identifier-plugin/src/Plugin.js",
"content": "class Plugin {\n onHandleDocs(ev) {\n const option = ev.data.option || {};\n if (!('enable' in option)) option.enable = false;\n\n const ignore = !option.enable;\n\n for (const doc of ev.data.docs) {\n if (doc.export === false && ignore && !('ignore' in doc)) {\n doc.ignore = ignore;\n }\n }\n }\n}\n\nmodule.exports = new Plugin();\n"
},
{
"path": "esdoc-unexported-identifier-plugin/test/esdoc.json",
"content": "{\n \"source\": \"./test/src\",\n \"destination\": \"./test/out\",\n \"excludes\": [\"\\\\.test\\\\.js$\"],\n \"plugins\": [\n {\"name\": \"./src/Plugin.js\"}\n ]\n}\n"
},
{
"path": "esdoc-unexported-identifier-plugin/test/init.js",
"content": "const path = require('path');\nconst fs = require('fs');\nconst ESDocCLI = require('esdoc/out/src/ESDocCLI.js').default;\n\nfunction cli() {\n const cliPath = path.resolve('./node_modules/esdoc/out/ESDocCLI.js');\n const argv = ['node', cliPath, '-c', './test/esdoc.json'];\n const cli = new ESDocCLI(argv);\n cli.exec();\n global.docs = JSON.parse(fs.readFileSync('./test/out/index.json').toString());\n}\n\ncli();\n"
},
{
"path": "esdoc-unexported-identifier-plugin/test/src/MyClass.js",
"content": "class MyClass1 {\n}\n\n/**\n * @ignore\n */\nexport class MyClass2 {\n}\n\nexport class MyClass3 {\n}\n"
},
{
"path": "esdoc-unexported-identifier-plugin/test/src/MyClass.test.js",
"content": "const assert = require('assert');\nconst {find, file} = require('../util');\n\ndescribe('test unexported identifier result:', ()=> {\n\n it('ignores unexported identifier.', ()=>{\n const doc = find('name', 'MyClass1');\n assert.equal(doc.export, false);\n assert.equal(doc.ignore, true);\n });\n\n it('ignores exported identifier with @ignore.', ()=>{\n const doc = find('name', 'MyClass2');\n assert.equal(doc.export, true);\n assert.equal(doc.ignore, true);\n });\n\n it('does not ignore exported identifier.', ()=>{\n const doc = find('name', 'MyClass3');\n assert.equal(doc.export, true);\n assert.equal(doc.ignore, undefined);\n });\n});\n\n"
},
{
"path": "esdoc-unexported-identifier-plugin/test/util.js",
"content": "const fs = require('fs');\n\nexports.find = function(key, ...values) {\n if (values.length === 1) {\n return global.docs.find((doc) => {\n if (typeof values[0] === 'string') return doc[key] === values[0];\n if (values[0] instanceof RegExp) return doc[key].match(values[0]);\n });\n }\n\n const results = [];\n for (const value of values) {\n const result = global.docs.find(doc => {\n if (typeof value === 'string') return doc[key] === value;\n if (value instanceof RegExp) return doc[key].match(value);\n });\n\n results.push(result);\n }\n\n return results;\n};\n\nexports.file = function (filePath) {\n return fs.readFileSync(filePath).toString();\n};\n\n"
},
{
"path": "script/check.sh",
"content": "#!/bin/bash\n\nfor plugin in $(ls -1 -d esdoc-*)\ndo\n cd $plugin\n# localDate=$(TZ=UTC git log --date=format-local:%Y-%m-%d -n 1 ./ | grep Date | cut -d ' ' -f 4 | cut -d 'T' -f 1)\n npmDate=$(npm view ./ | grep modified | awk -F \"'\" '{print $2}')\n log=$(git log --since=\"$npmDate\" --invert-grep --grep=\"bump v\" -n 1 ./)\n if [ \"$log\" != \"\" ]; then\n echo $plugin\n fi\n cd ../\ndone\n"
},
{
"path": "script/install.sh",
"content": "#!/bin/bash -e\n\nfor plugin in $(ls -1 -d esdoc-*)\ndo\n echo $plugin\n (cd $plugin && npm install)\n echo ========================================================================\ndone\n"
},
{
"path": "script/test.sh",
"content": "#!/bin/bash -e\n\nfor plugin in $(ls -1 -d esdoc-*)\ndo\n echo $plugin\n (cd $plugin && npm run test)\n echo ========================================================================\ndone\n"
}
]