Generate report files from the CLI

[gregswindle]

User story

As as developer/designer, I want to generate CRC models from a command line interface in order to automate design documents.

Acceptance criteria

• 1. Generate CRC models for a single file.
• 2. Generate CRC models for a directory, recursively, with glob patterns.
• 3. The CRC models will be on a single "page," e.g., crc-models.md.
• 4. The report displays:
  • a. The date and time that the report was generated.
  • b. The repository branch revision from which the report was generated.

5. The CRC Models can be restricted by Expression or Declaration type.

[gregswindle]

Task 1 - 3 are complete, but the analysis isn't quite right. For one thing, the identification of functions as Objects is too greedy. 😒 💳.

Will likely finish 4 and its sub-tasks before tackling the overall AST.

Update

If I limit evaluation to ClassDeclarations, ClassExpressions, and VariableDeclarations in the CrcModelVisitor.isDeclaration static method like so:

static isDeclaration(node) {
    const declarators = [
        //'FunctionDeclaration',
        //'FunctionExpression',
        //'ArrowFunctionExpression',
        'ClassDeclaration',
        'ClassExpression',
        'VariableDeclaration'//,
        //'VariableDeclarator'
    ];
    return _.includes(declarators, node.type);
}

The reports are restricted to "classes." The following command:

$ crc-model-cli './lib/**/*.js'

Generates the following report.

Example report of the v0.1.4 ./lib/**/*.js codebase

Class-Responsibility-Collaboration Model

for eslint-plugin-crc, v0.1.4
branch feat/#1-generate-reports-from-cli

CrcModelFormatter extends Object
Responsibilities	Collaborators

CrcModelListVisitor extends Object
Responsibilities	Collaborators

CrcModelList extends Object
Responsibilities	Collaborators
	CrcModelVisitor 332:48 CrcModelVisitor 351:36 CrcModel 414:31

CrcModelPrototypeVisitor extends CrcModelListVisitor
Responsibilities	Collaborators
	CrcModelListVisitor 445:39

CrcModelVisitor extends Object
Responsibilities	Collaborators

CrcModel extends Object
Responsibilities	Collaborators

---

Created on 2017-03-21T12:16:55.715Z with eslint-plugin-crc.

---

This obviously needs more work, but it's closer.

[gregswindle]

I've completely refactored eslint-plugin-crc in #41. There's an updated sample report, and the README for installation and usage instructions.