Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(responsibilities): display objects' duties and descriptions #187

Open
wants to merge 54 commits into
base: master
Choose a base branch
from
Open

feat(responsibilities): display objects' duties and descriptions #187

wants to merge 54 commits into from

Conversation

gregswindle
Copy link
Owner

@gregswindle gregswindle commented Jan 14, 2018 •
edited

Description of change

Add CRC Model descriptions and responsibilities.

📝 See CRC Model report sample in the eslint-plugin-crc Wiki for the latest results.

Associated issue(s)

  1. Closes feat(responsibilities): extract object responsibilities from JSDoc comments #44.
  2. Resolves Update snyk to the latest version 🚀 #136 (dependency drift)
  3. Resolves Update eslint to the latest version 🚀 #137 (dependency drift)
  4. Resolves Update nodemon to the latest version 🚀 #142 (dependency drift)
  5. Resolves Update eslint-plugin-jsdoc to the latest version 🚀 #146 (dependency drift)
  6. Resolves Update nyc to the latest version 🚀 #150 (dependency drift)
  7. Resolves Bump nyc from 11.3.0 to 11.4.1 #152 (dependency drift)
  8. Resolves Update semantic-release to the latest version 🚀 #153 (dependency drift)
  9. Resolves Bump semantic-release from 8.2.0 to 11.0.2 #156 (dependency drift)
  10. Resolves Update mocha to the latest version 🚀 #161 (dependency drift)
  11. Resolves chore(dependencies): Bump markdown-magic from 0.1.19 to 0.1.20 #162 (dependency drift)
  12. Resolves chore(dependencies): Bump mocha from 4.0.1 to 4.1.0 #164 (dependency drift)
  13. Resolves Update markdown-magic to the latest version 🚀 #165 (dependency drift)
  14. Resolves Update standard-version to the latest version 🚀 #168 (dependency drift)
  15. Resolves chore(dependencies): Bump standard-version from 4.2.0 to 4.3.0 #169 (dependency drift)
  16. Resolves Update doctrine to the latest version 🚀 #172 (dependency drift)
  17. Resolves chore(dependencies): Bump eslint-plugin-jsdoc from 3.2.0 to 3.3.1 #173 (dependency drift)
  18. Resolves chore(dependencies): Bump doctrine from 2.0.2 to 2.1.0 #175 (dependency drift)
  19. Resolves chore(dependencies): Bump eslint from 4.13.0 to 4.15.0 #177 (dependency drift)
  20. Resolves chore(dependencies): Bump nodemon from 1.12.5 to 1.14.11 #182 (dependency drift)
  21. Resolves chore(dependencies): Bump snyk from 1.54.1 to 1.68.0 #183 (dependency drift)
  22. Resolves Update eslint-plugin-jsdoc to the latest version 🚀 #213 (dependency drift)
  23. Resolves Update mocha to the latest version 🚀 #214 (dependency drift)
  24. Resolves build: bump eslint-plugin-jsdoc from 3.3.1 to 3.4.0 #215 (dependency drift)
  25. Resolves build: bump mocha from 5.0.0 to 5.0.1 #216 (dependency drift)
  26. Resolves build: bump eslint-plugin-jsdoc from 3.3.1 to 3.4.1 #218 (dependency drift)
  27. Resolves Update eslint-config-xo-space to the latest version 🚀 #219 (dependency drift)
  28. Resolves Update nsp to the latest version 🚀 #220 (dependency drift)
  29. Resolves Update nodemon to the latest version 🚀 #221 (dependency drift)
  30. Resolves build: bump nsp from 3.1.0 to 3.2.1 #222 (dependency drift)
  31. Resolves build: bump eslint-config-xo-space from 0.17.0 to 0.18.0 #223 (dependency drift)
  32. Resolves build: bump nodemon from 1.14.12 to 1.15.0 #224 (dependency drift)
  33. Resolves Update eslint to the latest version 🚀 #225 (dependency drift)
  34. Resolves build: bump eslint from 4.17.0 to 4.18.0 #227 (dependency drift)
  • The acceptance criteria for all associated issues have been completed, tested, and validated.

PR check-list

✅ Please review and check the appropriate items.

1. Code standards compliance

JavaScript Style Guide

  • ESLint passes.

2. Code quality. Quality Gate

  • The quality gateways pass with an "A" grade.
Measure Scores
Complexity Complexity
Cognitive complexity
Duplications Duplications
Issues Issues
Maintainability Code smells
Maintainability
Technical debt
Reliability Reliability
Security Security

3. Test coverage Coverage Status

  • The source code is 100% covered with passing specs.

ℹ️ These tasks are not required to open a PR, and may be addresses while the PR is open.

@gregswindle
test(main): verify resources in main lib/index.js
6460f3f 
#44
@gregswindle
build(config): update repo settings
56f0692 
1. Ignore vscode resources
2. Set to ES6
3. Declare browsers false
@gregswindle gregswindle self-assigned this Jan 14, 2018
@gregswindle gregswindle added this to Backlog in eslint-formatter-crc via automation Jan 14, 2018
@gregswindle gregswindle added this to the MVP 1 milestone Jan 14, 2018
@gregswindle
docs(api): update documentation
e81e212 
1. README usage, installation, and benefits
2. CONTRIBUTING product delivery flow
3. API docs
@gregswindle
feat(responsibilities): add class descriptions
4f14011 
#44,#187
@gregswindle
build(manifest): update dependencies
de2710c 
1. Add meow to simplify formatting from the CLI.
1. Resolve #136 (dependency drift)
1. Resolve #137 (dependency drift)
1. Resolve #142 (dependency drift)
1. Resolve #146 (dependency drift)
1. Resolve #150 (dependency drift)
1. Resolve #152 (dependency drift)
1. Resolve #153 (dependency drift)
1. Resolve #156 (dependency drift)
1. Resolve #161 (dependency drift)
1. Resolve #162 (dependency drift)
1. Resolve #164 (dependency drift)
1. Resolve #165 (dependency drift)
1. Resolve #168 (dependency drift)
1. Resolve #169 (dependency drift)
1. Resolve #172 (dependency drift)
1. Resolve #173 (dependency drift)
1. Resolve #175 (dependency drift)
1. Resolve #177 (dependency drift)
1. Resolve #182 (dependency drift)
1. Resolve #183 (dependency drift)

#44,#187
@coveralls
Copy link

coveralls commented Jan 14, 2018 •
edited

Coverage Status

Changes Unknown when pulling de2710c on feat/#44-responsibilities into ** on master**.

1 similar comment
@coveralls
Copy link

coveralls commented Jan 14, 2018 •
edited

Coverage Status

Changes Unknown when pulling de2710c on feat/#44-responsibilities into ** on master**.

@gregswindle
refactor(responsibilities): fix lint issues
aad0e4b 
1. Refactor:rename crc-*-templates with an html extension
2. Use method shorthand for cli's private msg object

#44,#187
@gregswindle
style(lint): revise ESLint config and resources
469b462 
1. Set  to inherit *everything* with
2. Alphabetize all object properties
4. Use arrow function declarations
5. Add and apply eslint-plugin-xo rules
6. Configure no-unsupported-features to expect Node v7.x or higher
7. Set security/detect-non-literal-fs-filename to warn instead of error
   **NOTE:** I don't like this, but I don't yet know how to harden my apps.
   TODO: harden apps to allow security/detect-non-literal-fs-filename

#44,#186
@gregswindle
style(lint): replace eslint-plugin-xo
8df0000 
eslint-plugin-xo has been deprecated in favor of eslint-plugin-unicorn, which
I replaced and configured.

Also ran npm dedupe.

#44,#187
@gregswindle
feat(responsibilities): clean dependencies and config
8de115a 
* build(dependencies): add eslint-config-scanjs
* build(dependencies): remove pluralize (unused)
* build(manifest): update node.engines to >=7.0.0
* ci(bithound): exclude tests from analysis
* docs(api): update
* docs(issues): revise ISSUE_TEMPLATE copy
* style(eslint): alphabetize and beautify .eslintrc.[yml,json]
* style(eslint): update parserOptions to ES 2017 and Node v7.x or higher
* style(scanjs): enable eslint-plugin-scanjs

#44,#187
@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 8df0000 on feat/#44-responsibilities into ** on master**.

@gregswindle
feat(responsibilities): clean dependencies and config
d66cfb6 
* build(dependencies): add eslint-config-scanjs
* build(dependencies): remove pluralize (unused)
* build(manifest): update node.engines to >=7.0.0
* ci(bithound): exclude tests from analysis
* docs(api): update
* docs(issues): revise ISSUE_TEMPLATE copy
* style(eslint): alphabetize and beautify .eslintrc.[yml,json]
* style(eslint): update parserOptions to ES 2017 and Node v7.x or higher
* style(scanjs): enable eslint-plugin-scanjs
@gregswindle
Merge branch 'feat/#44-responsibilities' of https://github.com/gregsw…
7260995 
…indle/eslint-plugin-crc into feat/#44-responsibilities
@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 7260995 on feat/#44-responsibilities into ** on master**.

@coveralls
Copy link

coveralls commented Jan 15, 2018 •
edited

Coverage Status

Changes Unknown when pulling 7260995 on feat/#44-responsibilities into ** on master**.

@gregswindle
docs(crc): update all docs
4a4a33f
@gregswindle
build(manifest): updated dependencies
b4dc1fd 
1. Revise description
2. eslint@4.16.0
3. eslint-scope@3.7.1
4. moch@5.0.0
5. snyk@1.69.1
6. Move npm-script lint into pretest and remove posttest
@gregswindle
build(dependencies): update depth 50
4bc6085 
#40,#187
@gregswindle
build(crc-model): add linkable names
34eba0b 
* Add linked names to CRC Models
* Add table of contents.

TODO: enable table of contents links.

#44,#187
@gregswindle
build(toc): add table of contents
8e49e54 
Also add images; the lookup by ES version is not working yet, however.

#44,#187
@gregswindle
build(toc): add table of contents
e8f61e3 
Also add images; the lookup by ES version is not working yet, however.
@gregswindle
feat(formatter): use 'crc' as command
0807583 
Users can now generate reports with the `crc` command, e.g.,

crc 'lib/crc/*.js'

Instead of

eslint-plugin-crc 'lib/crc/*.js'

#44,#187
@gregswindle
docs(api): specify property
6993580 
Use @Property and @memberof to specify a static getter.

#44,#187
@gregswindle
docs(api): update desc and return type
86f503b 
#44,#187
@gregswindle
refactor(responsibilty): update initialization
3964030 
Only use the create factory method, now.

#44,#187
@gregswindle
feat(responsibility): modify interface
d6c982f 
- Remove static method `assign`
- Remove private function `setDescription`
- Add two properties:
   * descriptions
   * primary

BREAKING CHANGE: `CrcResponsibility's` interface now has three properties:

1. `comments` - An array of doctrine comments.
2. `descriptions` - A string array of all property and method descriptions.
3. `primary` - The description that pertains to a CrcClass.

#44,#187
@gregswindle
feat(reports): add references
6ba9d95 
Add references (this might not be correct).

#44,#187
@gregswindle
test(package): watch for changes
f92cc65 
Execute tests as soon as a file changes

#44,#187
@gregswindle
test(fixtures): update fixtures
9f6fb0b 
Fix specs for

- crc-model
- crc-responsibility

#44,#187
@gregswindle
docs(mailmap): map emails
ae9e6ce 
Map three different emails to user 'Greg Swindle'.

#44,#187
@gregswindle
build(dependencies): update eslint
2a883c5 
#44,#187,#225
@gregswindle
docs(api): update API docs
1453fc2 
#44,#187
@gregswindle
docs(notice): update licenses
afca918 
#44,#187
@gregswindle
ci(sonar): disable branch.name
7411db8 
#44,#187
Repository owner deleted a comment Feb 18, 2018
Repository owner deleted a comment Feb 18, 2018
@gregswindle
style(lint): remove commented code
e2859db 
#44,#187
@gregswindle
docs(readme): rearrange badges
1538ea0 
#44,#187
@gregswindle
style(lint): alphabetize props
d9574b2 
#44,#187
@gregswindle
refactor(comments): add strategy pattern
852da7a 
Extend CommentStrategy to create a 'pluggable' interface for
getting JSDoc comments from source code.

#44,#187
@gregswindle
refactor(comments): add strategy pattern
3dcad3e 
Extend CommentStrategy to create a 'pluggable' interface for
getting JSDoc comments from source code.

#44,#187
@gregswindle
ci(all): enforce node versions
e0b09ab 
Restrict Node.js to versions

- 9
- 8
- 7.6.0

#44,#187
@gregswindle
build(packages): update dependencies
d8ec2b3 
1. boom@3.1.3:boom@7.1.1:dependencies
2. cryptiles@3.0.0:cryptiles@4.1.1:dependencies
3. debug@2.6.9:debug@3.1.0:dependencies
4. hawk@5.0.0:hawk@7.0.7:dependencies
5. hoek@4.2.1:hoek@5.0.3:devDependencies
6. nodemon@1.15.0:nodemon@1.15.1:devDependencies
7. request@2.82.0:request@2.83.0:dependencies

#44,#187
@gregswindle
refactor(responsibilities): use documentation.js
addbef8 
#44,#187
@gregswindle
Copy link
Owner Author

SonarQube analysis reported 2 issues

Note: The following issues were found on lines that were not modified in the pull request. Because these issues can't be reported as line comments, they are summarized here:

  1. MINOR catharsis-comments-strategy.js#L48: Immediately return this expression instead of assigning it to the temporary variable "comments". rule
  2. MINOR documentation-strategy.js#L31: Immediately return this expression instead of assigning it to the temporary variable "comments". rule

@gregswindle
style(new-cap): remediate eslint issue
6a64790 
1. Import module 'markdown-it' as lower-case 'markdownIt' to
   prevent eslint's 'new-cap' bellyaching.

#44,#187
@gregswindle
feat(formatters): add markdown formatters
0fa768b 
GH-44
Repository owner deleted a comment May 2, 2018
Repository owner deleted a comment May 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@gregswindle gregswindle

Labels
eslint: formatter priority: medium type: docs type: feature type: test
Projects
eslint-formatter-crc
  
In-progress
Milestone
MVP 1
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@gregswindle @coveralls