Skip to content

Commit

Permalink
refactor(comments): add strategy pattern
Browse files Browse the repository at this point in the history 
Extend CommentStrategy to create a 'pluggable' interface for
getting JSDoc comments from source code.

#44,#187
  • Loading branch information
@gregswindle
gregswindle committed Feb 19, 2018
1 parent 852da7a commit 3dcad3e
Show file tree
Hide file tree
Showing 37 changed files with 21,445 additions and 0 deletions.
530 changes: 530 additions & 0 deletions docs/api/eslint-plugin-crc/0.1.5-development/CommentsStrategy.html
View file

Large diffs are not rendered by default.

193 changes: 193 additions & 0 deletions docs/api/eslint-plugin-crc/0.1.5-development/CrcClass-NullCrcClass.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>NullCrcClass - Documentation</title>

<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CommentsStrategy.html">CommentsStrategy</a><ul class='methods'><li data-type='method'><a href="CommentsStrategy.html#parse">parse</a></li><li data-type='method'><a href="CommentsStrategy.html#toString">toString</a></li></ul></li><li><a href="CrcClass.html">CrcClass</a><ul class='members'><li data-type='member'><a href="CrcClass.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcClass.html#.create">create</a></li></ul></li><li><a href="CrcClass-NullCrcClass.html">NullCrcClass</a></li><li><a href="CrcCodebase.html">CrcCodebase</a><ul class='methods'><li data-type='method'><a href="CrcCodebase.html#load">load</a></li></ul></li><li><a href="CrcContext.html">CrcContext</a><ul class='members'><li data-type='member'><a href="CrcContext.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcContext.html#.parse">parse</a></li></ul></li><li><a href="CrcContext-NullCrcContext.html">NullCrcContext</a></li><li><a href="CrcMeta.html">CrcMeta</a><ul class='members'><li data-type='member'><a href="CrcMeta.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcMeta-NullCrcMeta.html">NullCrcMeta</a></li><li><a href="CrcModel.html">CrcModel</a><ul class='members'><li data-type='member'><a href="CrcModel.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcModel-NullCrcModel.html">NullCrcModel</a></li><li><a href="CrcReporter.html">CrcReporter</a><ul class='methods'><li data-type='method'><a href="CrcReporter.html#report">report</a></li></ul></li><li><a href="CrcResponsibility.html">CrcResponsibility</a><ul class='methods'><li data-type='method'><a href="CrcResponsibility.html#.create">create</a></li><li data-type='method'><a href="CrcResponsibility.html#valueOf">valueOf</a></li></ul></li><li><a href="eslint-plugin-crc_formatters_md.EsImgMap.html">EsImgMap</a><ul class='methods'><li data-type='method'><a href="eslint-plugin-crc_formatters_md.EsImgMap.html#findByDescriptor">findByDescriptor</a></li><li data-type='method'><a href="eslint-plugin-crc_formatters_md.EsImgMap.html#findByEsVersion">findByEsVersion</a></li><li data-type='method'><a href="eslint-plugin-crc_formatters_md.EsImgMap.html#toHtmlLinkElemString">toHtmlLinkElemString</a></li></ul></li><li><a href="MdnReference.html">MdnReference</a><ul class='methods'><li data-type='method'><a href="MdnReference.html#get">get</a></li><li data-type='method'><a href="MdnReference.html#link">link</a></li></ul></li><li><a href="module-crc_typedef.CatharsisCommentsStrategy.html">CatharsisCommentsStrategy</a><ul class='methods'><li data-type='method'><a href="module-crc_typedef.CatharsisCommentsStrategy.html#parse">parse</a></li><li data-type='method'><a href="module-crc_typedef.CatharsisCommentsStrategy.html#toString">toString</a></li></ul></li><li><a href="module-crc_typedef.DocumentationCommentsStrategy.html">DocumentationCommentsStrategy</a><ul class='methods'><li data-type='method'><a href="module-crc_typedef.DocumentationCommentsStrategy.html#parse">parse</a></li><li data-type='method'><a href="module-crc_typedef.DocumentationCommentsStrategy.html#toString">toString</a></li></ul></li><li><a href="NodeManager.html">NodeManager</a><ul class='methods'><li data-type='method'><a href="NodeManager.html#.getAllNodes">getAllNodes</a></li><li data-type='method'><a href="NodeManager.html#.getNamespace">getNamespace</a></li><li data-type='method'><a href="NodeManager.html#.getNodeName">getNodeName</a></li></ul></li><li><a href="PrototypeInspector.html">PrototypeInspector</a><ul class='methods'><li data-type='method'><a href="PrototypeInspector.html#.getPrototypeOf">getPrototypeOf</a></li><li data-type='method'><a href="PrototypeInspector.html#.getScopeOf">getScopeOf</a></li></ul></li><li><a href="SourceCodeFactory.html">SourceCodeFactory</a><ul class='members'><li data-type='member'><a href="SourceCodeFactory.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="SourceCodeFactory.html#.create">create</a></li><li data-type='method'><a href="SourceCodeFactory.html#.getAst">getAst</a></li><li data-type='method'><a href="SourceCodeFactory.html#.parse">parse</a></li></ul></li><li><a href="SourceCodeFactory-NullSourceCode.html">NullSourceCode</a></li></ul><h3>Modules</h3><ul><li><a href="module-crc.html">crc</a><ul class='members'><li data-type='member'><a href="module-crc.html#.crcLogger">crcLogger</a></li></ul></li><li><a href="module-crc_formatters.module_crc_formatters_md.html">crc/formatters/md</a><ul class='methods'><li data-type='method'><a href="module-crc_formatters.module_crc_formatters_md.html#~format">format</a></li></ul></li><li><a href="module-crc_typedef.html">crc/typedef</a></li></ul><h3>Interfaces</h3><ul><li><a href="LinkElement.html">LinkElement</a><ul class='methods'><li data-type='method'><a href="LinkElement.html#link">link</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html">astConfig</a></li><li><a href="global.html#crcLogger">crcLogger</a></li><li><a href="global.html">descriptionFromContext</a></li></ul>
</nav>

<div id="main">

<h1 class="page-title">NullCrcClass</h1>







<section>

<header>

<h2>
<span class="ancestors"><a href="CrcClass.html">CrcClass</a>~</span>

NullCrcClass
</h2>

<div class="class-description"><p>A CrcClass NullObject.</p>
<p>🔒 <strong>Note:</strong> <code>NullCrcClass</code> instances can <strong>only</strong> be created using the
static getter <code>CrcClass.nullObject</code>.</p></div>


</header>

<article>
<div class="container-overview">




<h2>Constructor</h2>


<h4 class="name" id="NullCrcClass"><span class="type-signature">(protected) </span>new NullCrcClass<span class="signature">()</span><span class="type-signature"></span></h4>






<dl class="details">


<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-class.js.html">crc/crc-class.js</a>, <a href="crc_crc-class.js.html#line155">line 155</a>
</li></ul></dd>































</dl>













<h5>Example</h5>

<pre class="prettyprint"><code>const nullCrcClass = CrcClass.nullObject;</code></pre>



















</div>


<h3 class="subsection-title">Extends</h3>




<ul>
<li><a href="CrcClass.html">CrcClass</a></li>
</ul>



















</article>

</section>




</div>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 10:18:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
193 changes: 193 additions & 0 deletions docs/api/eslint-plugin-crc/0.1.5-development/CrcContext-NullCrcContext.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>NullCrcContext - Documentation</title>

<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CommentsStrategy.html">CommentsStrategy</a><ul class='methods'><li data-type='method'><a href="CommentsStrategy.html#parse">parse</a></li><li data-type='method'><a href="CommentsStrategy.html#toString">toString</a></li></ul></li><li><a href="CrcClass.html">CrcClass</a><ul class='members'><li data-type='member'><a href="CrcClass.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcClass.html#.create">create</a></li></ul></li><li><a href="CrcClass-NullCrcClass.html">NullCrcClass</a></li><li><a href="CrcCodebase.html">CrcCodebase</a><ul class='methods'><li data-type='method'><a href="CrcCodebase.html#load">load</a></li></ul></li><li><a href="CrcContext.html">CrcContext</a><ul class='members'><li data-type='member'><a href="CrcContext.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcContext.html#.parse">parse</a></li></ul></li><li><a href="CrcContext-NullCrcContext.html">NullCrcContext</a></li><li><a href="CrcMeta.html">CrcMeta</a><ul class='members'><li data-type='member'><a href="CrcMeta.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcMeta-NullCrcMeta.html">NullCrcMeta</a></li><li><a href="CrcModel.html">CrcModel</a><ul class='members'><li data-type='member'><a href="CrcModel.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcModel-NullCrcModel.html">NullCrcModel</a></li><li><a href="CrcReporter.html">CrcReporter</a><ul class='methods'><li data-type='method'><a href="CrcReporter.html#report">report</a></li></ul></li><li><a href="CrcResponsibility.html">CrcResponsibility</a><ul class='methods'><li data-type='method'><a href="CrcResponsibility.html#.create">create</a></li><li data-type='method'><a href="CrcResponsibility.html#valueOf">valueOf</a></li></ul></li><li><a href="eslint-plugin-crc_formatters_md.EsImgMap.html">EsImgMap</a><ul class='methods'><li data-type='method'><a href="eslint-plugin-crc_formatters_md.EsImgMap.html#findByDescriptor">findByDescriptor</a></li><li data-type='method'><a href="eslint-plugin-crc_formatters_md.EsImgMap.html#findByEsVersion">findByEsVersion</a></li><li data-type='method'><a href="eslint-plugin-crc_formatters_md.EsImgMap.html#toHtmlLinkElemString">toHtmlLinkElemString</a></li></ul></li><li><a href="MdnReference.html">MdnReference</a><ul class='methods'><li data-type='method'><a href="MdnReference.html#get">get</a></li><li data-type='method'><a href="MdnReference.html#link">link</a></li></ul></li><li><a href="module-crc_typedef.CatharsisCommentsStrategy.html">CatharsisCommentsStrategy</a><ul class='methods'><li data-type='method'><a href="module-crc_typedef.CatharsisCommentsStrategy.html#parse">parse</a></li><li data-type='method'><a href="module-crc_typedef.CatharsisCommentsStrategy.html#toString">toString</a></li></ul></li><li><a href="module-crc_typedef.DocumentationCommentsStrategy.html">DocumentationCommentsStrategy</a><ul class='methods'><li data-type='method'><a href="module-crc_typedef.DocumentationCommentsStrategy.html#parse">parse</a></li><li data-type='method'><a href="module-crc_typedef.DocumentationCommentsStrategy.html#toString">toString</a></li></ul></li><li><a href="NodeManager.html">NodeManager</a><ul class='methods'><li data-type='method'><a href="NodeManager.html#.getAllNodes">getAllNodes</a></li><li data-type='method'><a href="NodeManager.html#.getNamespace">getNamespace</a></li><li data-type='method'><a href="NodeManager.html#.getNodeName">getNodeName</a></li></ul></li><li><a href="PrototypeInspector.html">PrototypeInspector</a><ul class='methods'><li data-type='method'><a href="PrototypeInspector.html#.getPrototypeOf">getPrototypeOf</a></li><li data-type='method'><a href="PrototypeInspector.html#.getScopeOf">getScopeOf</a></li></ul></li><li><a href="SourceCodeFactory.html">SourceCodeFactory</a><ul class='members'><li data-type='member'><a href="SourceCodeFactory.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="SourceCodeFactory.html#.create">create</a></li><li data-type='method'><a href="SourceCodeFactory.html#.getAst">getAst</a></li><li data-type='method'><a href="SourceCodeFactory.html#.parse">parse</a></li></ul></li><li><a href="SourceCodeFactory-NullSourceCode.html">NullSourceCode</a></li></ul><h3>Modules</h3><ul><li><a href="module-crc.html">crc</a><ul class='members'><li data-type='member'><a href="module-crc.html#.crcLogger">crcLogger</a></li></ul></li><li><a href="module-crc_formatters.module_crc_formatters_md.html">crc/formatters/md</a><ul class='methods'><li data-type='method'><a href="module-crc_formatters.module_crc_formatters_md.html#~format">format</a></li></ul></li><li><a href="module-crc_typedef.html">crc/typedef</a></li></ul><h3>Interfaces</h3><ul><li><a href="LinkElement.html">LinkElement</a><ul class='methods'><li data-type='method'><a href="LinkElement.html#link">link</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html">astConfig</a></li><li><a href="global.html#crcLogger">crcLogger</a></li><li><a href="global.html">descriptionFromContext</a></li></ul>
</nav>

<div id="main">

<h1 class="page-title">NullCrcContext</h1>







<section>

<header>

<h2>
<span class="ancestors"><a href="CrcContext.html">CrcContext</a>~</span>

NullCrcContext
</h2>

<div class="class-description"><p>A CrcContext NullObject.</p>
<p>🔒 <strong>Note:</strong> <code>NullCrcContext</code> instances can <strong>only</strong> be created using the
static getter <code>CrcContext.nullObject</code>.</p></div>


</header>

<article>
<div class="container-overview">




<h2>Constructor</h2>


<h4 class="name" id="NullCrcContext"><span class="type-signature">(protected) </span>new NullCrcContext<span class="signature">()</span><span class="type-signature"></span></h4>






<dl class="details">


<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-context.js.html">crc/crc-context.js</a>, <a href="crc_crc-context.js.html#line56">line 56</a>
</li></ul></dd>































</dl>













<h5>Example</h5>

<pre class="prettyprint"><code>const nullCrcContext = CrcContext.nullObject;</code></pre>



















</div>


<h3 class="subsection-title">Extends</h3>




<ul>
<li><a href="CrcContext.html">CrcContext</a></li>
</ul>



















</article>

</section>




</div>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 10:18:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>

0 comments on commit 3dcad3e

Please sign in to comment.