Merge pull request #175 from EasyPost/cleanup_lint_config

chore: cleanup lint config
EasyPost · Feb 24, 2025 · 800afbd · 800afbd
2 parents 7669825 + 330d1f0
commit 800afbd
Show file tree

Hide file tree

Showing 8 changed files with 2,078 additions and 1,455 deletions.
diff --git a/.babelrc b/.babelrc
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -9,53 +9,56 @@ GEM
   specs:
     ast (2.4.2)
     easypost (6.2.0)
-    json (2.7.2)
-    parallel (1.24.0)
-    parser (3.3.2.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    regexp_parser (2.9.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
-    rubocop (1.49.0)
+    regexp_parser (2.10.0)
+    rubocop (1.72.0)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-rspec (2.30.0)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
       rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-24
   x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
   examples!
-  rubocop (= 1.49)
-  rubocop-rspec (~> 2.19)
+  rubocop (= 1.72)
+  rubocop-rspec (~> 2.31)
 
 BUNDLED WITH
    2.5.11
diff --git a/README.md b/README.md
@@ -2,16 +2,18 @@
 
 [![CI](https://github.com/EasyPost/examples/workflows/CI/badge.svg)](https://github.com/EasyPost/examples/actions?query=workflow%3ACI)
 
-This repository holds hundreds of code examples for using the EasyPost API across 7+ programming languages.
+Thousands of code examples for using the EasyPost API across 7+ programming languages.
 
 ## Folder Structure
 
-- `official` holds all the official code snippets that populate on the EasyPost website
-  - `docs` holds all the code snippets that populate on our API docs page. Each language will have its own subdirectory
-  - `fixtures` holds all of the test data used as fixtures in our client library test suites
-  - `guides` holds all the code snippets that populate on our guides page. Each language will have its own subdirectory
-  - `responses` holds all of the associated responses for our example snippets found in the `docs` directory that will give you a good idea of what to expect back from the EasyPost API
-- `community` holds code snippets contributed from the community. These may include custom workflows, how to integrate EasyPost with other software, etc. These are **unofficial** and **not supported or maintained by EasyPost**.
+- `official` official code snippets that populate on the EasyPost website
+  - `docs` code snippets that populate on our API docs page. Each language will have its own subdirectory
+  - `fixtures` test data used as fixtures in our client library test suites
+  - `guides` code snippets that populate on our guides page. Each language will have its own subdirectory
+  - `responses` responses for our example snippets found in the `docs` directory that will give you a good idea of what to expect back from the EasyPost API
+- `community` code snippets contributed from the community. These may include custom workflows, how to integrate EasyPost with other software, etc. These are **unofficial** and **not supported or maintained by EasyPost**.
+
+> NOTE: filenames may not match language convention - this is intentional. Our documentation website uses these example snippets and expects folder/filenames to follow a certain templated naming convention.
 
 ## Usage
 
@@ -26,5 +28,3 @@ make install-python
 ```
 
 Once installed, run an example like you would any other script or tool for that language.
-
-NOTE: filenames may not match language convention - this is intentional. Our website also uses these example snippets and expects folder/filenames to follow a certain templated naming convention.
diff --git a/examples.gemspec b/examples.gemspec
@@ -3,7 +3,7 @@
 Gem::Specification.new do |spec|
   spec.name                   = 'examples'
   spec.version                = '0.1.0'
-  spec.required_ruby_version  = '>= 2.6'
+  spec.required_ruby_version  = '>= 2.7'
   spec.summary                = 'Code examples for the EasyPost API'
   spec.description            = 'Code examples for the EasyPost API.'
   spec.authors                = ['EasyPost']
@@ -13,6 +13,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'easypost', '~> 6'
 
-  spec.add_development_dependency 'rubocop', '= 1.49'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.19'
+  spec.add_development_dependency 'rubocop', '= 1.72'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.31' # Can't upgrade to v3 until we drop Ruby 2.7
 end