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

refactor(docs): normalize dir naming and casing #2863

Merged
merged 10 commits into from
Jun 1, 2018

Conversation

levithomason
Copy link
Member

@levithomason levithomason commented Jun 1, 2018

CHANGES

BEFORE               AFTER

/docs            ->  /docs
  /app           ->    /src
    /Components  ->      /components
    /Examples    ->      /examples
    /HOC         ->      /hoc
    /Layouts     ->      /layouts
    /Views       ->      /views
  /build         ->    /dist

UPGRADE

1. Rename directories

rm -rf docs/build
mv docs/app docs/src
mv docs/src/Components docs/src/components
mv docs/src/Examples docs/src/examples
mv docs/src/HOC docs/src/hoc
mv docs/src/Layouts docs/src/layouts
mv docs/src/Views docs/src/views

2. Rename files

mv gulp/plugins/util/parseDocBlock.js gulp/plugins/util/parseDocblock.js
mv src/lib/eventStack/eventStack.js src/lib/eventStack/EventStack.js
mv test/specs/commonTests/hasSubComponents.js test/specs/commonTests/hasSubcomponents.js
mv test/specs/lib/eventStack/eventStack-test.js test/specs/lib/eventStack/EventStack-test.js

3. Find and replace

docs/build      ->  docs/dist
docs/app        ->  docs/src
src/Components  ->  src/components
/Examples       ->  /examples
/HOC            ->  /hoc
/Layouts        ->  /layouts
/Views          ->  /views

4. Fix lint

Run lint and fix any reported errors.

yarn lint:fix
yarn tsd:lint:fix

5. Update paths in git

Changing path casing in git will not register changes. Remove and re-add the files for git to track them.

git rm -rf . --cached
git add -A
git commit -m 'refactor(docs): normalize directory structure'

6. Squash and rebase

Now that you're directory structure is in sync, squash your branch commits and rebase it off of master.

⚠️ Update your master branch first!

Squash:

git reset $(git merge-base master YOUR_BRANCH)
git add -A
git commit -m "one commit on yourBranch"

Rebase:

git rebase master

Fix conflicts, ensure your changes are OK, commit, and push.

@levithomason levithomason changed the title refactor(docs): normalize folder casing refactor(docs): normalize dir naming and casing Jun 1, 2018
@codecov-io
Copy link

codecov-io commented Jun 1, 2018

Codecov Report

Merging #2863 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2863   +/-   ##
=======================================
  Coverage   99.67%   99.67%           
=======================================
  Files         161      161           
  Lines        2733     2733           
=======================================
  Hits         2724     2724           
  Misses          9        9

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5ebeedf...eae90bc. Read the comment docs.

@levithomason levithomason merged commit 576dacb into master Jun 1, 2018
@levithomason levithomason deleted the refactor/docs-folders branch June 1, 2018 21:08
@levithomason
Copy link
Member Author

Released in semantic-ui-react@0.81.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants