Skip to content

Commit 723fb5f

Browse files
authored
[chore] Import style guide from examples submodule (#270)
- Delete local style guide, add to .gitignore - Make step to import style guides from examples submodule - Re-org Make steps as needed - Rename "make fix" to "make format" for consistency with other libraries
1 parent bf684cd commit 723fb5f

File tree

7 files changed

+23
-207
lines changed

7 files changed

+23
-207
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ jobs:
4444
bundler-cache: true
4545
- name: Install Dependencies
4646
run: make install
47+
- name: Install style guides
48+
run: make install-styleguide
4749
- name: Lint Project
4850
run: make lint
4951
- name: Run security analysis

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,5 @@ test/tmp
2424
test/version_tmp
2525
tmp
2626
vendor/
27+
/easycop.yml
28+
/.rubocop.yml

.rubocop.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

Makefile

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,23 @@ coverage:
2020
docs:
2121
bundle exec rdoc lib -o docs --title "EasyPost Ruby Docs"
2222

23-
## fix - Fix Rubocop errors
24-
fix:
23+
## format - Fix Rubocop errors
24+
format:
2525
bundle exec rubocop -a
2626

27+
## install-styleguide - Import the style guides (Unix only)
28+
install-styleguide: | update-examples-submodule
29+
sh examples/symlink_directory_files.sh examples/style_guides/ruby .
30+
2731
## install - Install globally from source
28-
install:
29-
git submodule init
30-
git submodule update
32+
install: | update-examples-submodule
3133
bundle install
3234

35+
## update-examples-submodule - Update the examples submodule
36+
update-examples-submodule:
37+
git submodule init
38+
git submodule update --remote
39+
3340
## lint - Lint the project
3441
lint:
3542
bundle exec rubocop
@@ -52,8 +59,6 @@ test:
5259
bundle exec rspec
5360

5461
## update - Updates dependencies
55-
update:
56-
git submodule init
57-
git submodule update --remote
62+
update: | update-examples-submodule
5863

59-
.PHONY: help build clean coverage docs fix install lint publish release scan test update
64+
.PHONY: help build clean coverage docs format install install-styleguide lint publish release scan test update update-examples-submodule

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,14 @@ For additional support, see our [org-wide support policy](https://github.com/Eas
136136
# Install dependencies
137137
make install
138138

139+
# Install style guide (Unix only)
140+
make install-style
141+
139142
# Lint project
140143
make lint
141144

142145
# Fix linting errors
143-
make fix
146+
make format
144147

145148
# Run tests (coverage is generated on a successful test suite run)
146149
EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test

easycop.yml

Lines changed: 0 additions & 180 deletions
This file was deleted.

examples

Submodule examples updated 648 files

0 commit comments

Comments
 (0)