Skip to content

refactor: evaluate RuleElements with @sindresorhus/ow#isValid#101

Open
gregswindle wants to merge 6 commits intomasterfrom
97-refactoring-ow-is-valid
Open

refactor: evaluate RuleElements with @sindresorhus/ow#isValid#101
gregswindle wants to merge 6 commits intomasterfrom
97-refactoring-ow-is-valid

Conversation

@gregswindle
Copy link
Contributor

@gregswindle gregswindle commented Aug 27, 2019 •
edited
Loading

git Pull Request Pull Request (PR)

  1. Refactor all RuleElement operator methods to use @sindresorhus/ow#isValid.
  2. Remove unused development and production dependencies.
  3. Update all third-party dependencies to their latest versions.
  4. Rename archetypes-rules => @archetypes/rules.

Associated issue(s)

Closes #97
Closes #103

  • 1. The acceptance criteria for all associated issues have been
    completed, tested, and validated.
  • 2. The README either reflects my changes or does not require updates.
  • 3. The CONTRIBUTING document either reflects my changes or does not
    require updates.
View the "Code Review Cheat-sheet"...

Rule 1: Review all Code before Releasing it

Do the code reviews before deployment.

Why:

Your team will end up, on average, spending 7% more of its time on building
new features compared with those who do after, and 10% more than those who
don’t do code reviews at all.

Rule 2: All developers review code

Make sure all your developers get to review code.

Why:

This will improve the feeling of empowerment, facilitate knowledge transfer,
and improve developer satisfaction and productivity.

Rule 3: Four-to-Eight (4-8) Hours per Developers per Week

The optimal amount of time to spend on code reviews is between 0.5 to 1 day per
week per developer.

Rule 4: Don't Release Code that Fails Reviews

Make code reviews blocking, that is, don’t deploy before they have been carried
out.

Rule 5: More Rigor, Better Quality and Velocity

Be strict and thorough when reviewing code.

Why:

Your code quality and velocity will thank you.

Code quality summary

Measure Scores
Quality gate Sonar Alert Status Metrics
Duplications Sonar Duplicated Lines Density Metrics
Maintainability Sonar Code Smells Metrics
Sonar Sqale Rating Metrics
Sonar Sqale Index Metrics
Sonar Ncloc Metrics
Reliability Sonar Reliability Rating Metrics
Sonar Bugs Metrics
Security Sonar Security Rating Metrics
Sonar Vulnerabilities Metrics
Test coverage Sonar Coverage Metrics

Code quality, vulnerability, and standards compliance tools

Code Style Linters Test frameworks
JavaScript Style Guide ESLint Jest BDD
Standard JS user guide link-external ESlint user guide link-external Jest user guide link-external

How to format, lint, and test your changes

Open a Terminal, go to the root directory for archetypes-rules, and run:

$ npm test

info Completed tasks are not required to open a PR, and may
be addressed while the PR is open.

alert All tasks must be completed and verified
before a PR may be merged into master, however.

How to test a release

The Pre-release test instructions include step-by-step guidelines for bundling, packing, and testing this module as it would be released on NPM.

@gregswindle
fix(package): update dependencies
87fc615 
Production

1.  @sindresorhus/is@1.0.0
2.  fs-extra@8.1.0

Development

1.  @semantic-release/changelog@3.0.4
2.  @semantic-release/commit-analyzer@6.3.0
3.  @semantic-release/git@7.0.16
4.  @semantic-release/github@5.4.3
5.  @semantic-release/npm@5.1.15
6.  @semantic-release/release-notes-generator@7.3.0
7.  all-contributors-cli@6.8.1
8.  commitizen@4.0.3
9.  coveralls@3.0.6
10. eslint@6.2.2
11. eslint-config-prettier@6.1.0
12. eslint-config-standard@14.0.1
13. eslint-find-rules@3.4.0
14. eslint-plugin-import@2.18.2
15. eslint-plugin-promise@4.2.1
16. eslint-plugin-standard@4.0.1
17. eslint-plugin-unicorn@10.0.0
18. husky@3.0.4
19. jest@24.9.0
20. jest-junit@7.0.0
21. jsdoc@3.6.3
22. lint-staged@9.2.3
23. prettier@1.18.2
24. remark@11.0.1
25. remark-frontmatter@1.3.2
26. remark-lint@6.0.5
27. remark-preset-lint-consistent@2.0.3
28. remark-preset-lint-markdown-style-guide@2.1.3
29. remark-preset-lint-recommended@3.0.3
30. remark-retext@3.1.3
31. retext-english@3.0.3
32. retext-repeated-words@2.0.0
33. retext-sentence-spacing@3.0.0
34. retext-spell@3.0.0
35. retext-syntax-urls@1.0.2
36. rollup@1.20.1
37. rollup-plugin-commonjs@10.0.2
38. rollup-plugin-node-resolve@5.2.0
39. rollup-plugin-terser@5.1.1
40. semantic-release@15.13.24
41. sonarqube-scanner@2.5.0
42. unified@8.3.2

Run

- npm audit fix
- npm prune
- npm dedupe

Closes #57
Closes #66
Closes #69
Closes #70
Closes #72
Closes #80
Closes #84
Closes #87
Closes #95
Closes #99
@gregswindle
chore(package): clean dependencies
0643ce9 
Update dev-dependencies:

1.  jest-junit@8.0.0 --save-dev
2.  lint-staged@9.2.4 --save-dev
3.  rollup@1.20.2 --save-dev

Remove unused dev and prod dependencies.

\#97
@gregswindle gregswindle self-assigned this Aug 27, 2019
@gregswindle gregswindle added type: breaking change Modifications affect or replace the public API. ⇧ Bumps the MAJOR semver. type: dependency Update or pin a third-party library. ⇧ Bump the PATCH semver. type: refactor Restructuring source code without changing its external behavior. type: test Adding, correcting, or improving tests (coverage). labels Aug 27, 2019
qlty-cloud-legacy[bot]
qlty-cloud-legacy bot reviewed Aug 27, 2019
View reviewed changes
Copy link

@qlty-cloud-legacy qlty-cloud-legacy bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR diff size of 41721 lines exceeds the maximum allowed for the inline comments feature.

@gregswindle
fix(package): update outdated dependencies
ea5711f 
Update dev-dependencies:

1.  all-contributors-cli@6.9.0
2.  better-docs@1.2.2
3.  eslint@6.3.0
4.  eslint-config-prettier@6.2.0
5.  eslint-config-standard@14.1.0
6.  eslint-plugin-node@10.0.0
7.  husky@3.0.5
8.  lint-staged@9.2.5
9.  rollup@1.20.3
10. rollup-plugin-commonjs@10.1.0

\#97
qlty-cloud-legacy[bot]
qlty-cloud-legacy bot reviewed Sep 7, 2019
View reviewed changes
Copy link

@qlty-cloud-legacy qlty-cloud-legacy bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR diff size of 43253 lines exceeds the maximum allowed for the inline comments feature.

@commonality commonality deleted a comment Sep 7, 2019
@gregswindle
refactor(package): replace lodash.hasin
035db0f 
Replace module lodash.hasin (4 KB) with private
function objectHasPropertyName (500 B)

#97
@gregswindle
refactor(method-count): remove extra functions
c1e412f 
- Remove ArrayVariable.prototype.isNonEmpty
- Rename Proposition results' names to match their
  operator method names.

#103
@gregswindle
refactor(function): move function up
b8629f2 
Move up function assignTypeTo for reuse.

#97
qlty-cloud-legacy[bot]
qlty-cloud-legacy bot reviewed Sep 7, 2019
View reviewed changes
Copy link

@qlty-cloud-legacy qlty-cloud-legacy bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR diff size of 43356 lines exceeds the maximum allowed for the inline comments feature.

@qlty-cloud-legacy
Copy link

qlty-cloud-legacy bot commented Sep 7, 2019

Code Climate has analyzed commit b8629f2 and detected 0 issues on this pull request.

View more on Code Climate.

@commonality commonality deleted a comment Sep 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@qlty-cloud-legacy qlty-cloud-legacy[bot] qlty-cloud-legacy[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@gregswindle gregswindle

Labels

type: breaking change Modifications affect or replace the public API. ⇧ Bumps the MAJOR semver. type: dependency Update or pin a third-party library. ⇧ Bump the PATCH semver. type: refactor Restructuring source code without changing its external behavior. type: test Adding, correcting, or improving tests (coverage).

Projects

None yet

Milestone

Refactor modules with @sindresorhus.c...

Development

Successfully merging this pull request may close these issues.

Fix "method_count" issue in lib/variable/array-variable.js refactoring: evaluate RuleElements with @sindresorhus/ow/isValid

1 participant

@gregswindle