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.

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

chore: refactor how copy readme script prints output to terminal #1546

Merged
merged 3 commits into from Mar 30, 2019

Conversation

Projects
None yet
4 participants
@jkmdev
Copy link
Contributor

jkmdev commented Mar 15, 2019

Description

Makes small improvements to the build/documentation/copy-package-readme.js file including:

  • uses the chalk dependency to make console.log statements easier to read
  • makes the terminal output itself easier to read, makes it easier to see if all doc readmes were updated successfully
  • makes it so that the glob function recognizes lowercase readme titles in POSIX systems

Motivation & context

I would notice these smaller issues while writing build/documentation/generate-typedocs.js and decided to make a separate PR for them.

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.
Show resolved Hide resolved build/documentation/copy-package-readme.js Outdated
Show resolved Hide resolved build/documentation/copy-package-readme.js Outdated

@awentzel awentzel changed the title refactor: update how copy readme script prints output to terminal chore: update to refactor how copy readme script prints output to terminal Mar 19, 2019

@chrisdholt chrisdholt changed the title chore: update to refactor how copy readme script prints output to terminal chore: refactor how copy readme script prints output to terminal Mar 21, 2019

@nicholasrice
Copy link
Member

nicholasrice left a comment

Waiting on PR until v4 changes can be merged into master.

@jkmdev jkmdev force-pushed the jkmdev:script-clean-up branch from 9d60687 to 1aebb8d Mar 26, 2019

@chrisdholt

This comment has been minimized.

Copy link
Member

chrisdholt commented Mar 30, 2019

@jkmdev If you want to rebase this I'll make sure we get it merged in; just ping me when it's ready!

@jkmdev jkmdev force-pushed the jkmdev:script-clean-up branch from 1aebb8d to 79384df Mar 30, 2019

@codeclimate

This comment has been minimized.

Copy link

codeclimate bot commented Mar 30, 2019

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

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 87.8% (0.0% change).

View more on Code Climate.

@chrisdholt chrisdholt merged commit 524d4b7 into Microsoft:master Mar 30, 2019

6 checks passed

ci/circleci: build_dependencies Your tests passed on CircleCI!
Details
ci/circleci: test_coverage Your tests passed on CircleCI!
Details
codeclimate All good!
Details
codeclimate/diff-coverage 100% (50% threshold)
Details
codeclimate/total-coverage 87% (0.0% change)
Details
license/cla All CLA requirements met.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.