jslinting-rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2f8c0ce79c85ed178f30d654fe012f01b11b2fdedb62708567f0d2ccae7c25a
+  data.tar.gz: 17568f673307da1e2bee6e2c496f57bfcfe73d8d4361a6b84e801eade6ffeb70
+SHA512:
+  metadata.gz: e7f6ca972cf10d09a5ecdbcc602a61e16800cfa3fb4b15f26d0898d44ca172e075a98770eb8d229ea43c24fc19959de7f785f02b4ec4184b8ca0d24236276ff6
+  data.tar.gz: 57a3e30c1680b84f8f5c8c997475ef3d9fc77233a061f2ce571c61a6eaf0bd4b724867588523a861d4789a858ec1bbe2e636b6eaa32a6a3ee49e3e5cfa576fb2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Ethan Kircher
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# JavaScript Linting for Rails
+
+This gem provides a basic eslint and prettier setup for Rails apps setup with [jsbundling-rails](https://github.com/rails/jsbundling-rails).
+
+## Installation
+
+Ensure [jsbundling-rails](https://github.com/rails/jsbundling-rails) is installed in your application, as
+`jslinting-rails` relies on it.
+
+If you are using node, ensure npx >7.1 is installed.
+
+If you are using bun, then you must have the bun runtime installed.
+
+To get started run:
+
+```bash
+./bin/bundle add jslinting-rails --group development
+```
+
+```bash
+./bin/rails jslinting:install
+```
+
+## Usage
+
+This gem adds two scripts to your `package.json`, `lint` and `format`.
+
+They can be run directly through your package manager with
+
+```bash
+yarn run lint
+yarn run format
+```
+
+or as a task via
+
+```bash
+rails javascript:lint
+rails javascript:format
+```
+
+## License
+
+`jslinting-rails` is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/install/eslint/eslint.config.mjs

@@ -0,0 +1,9 @@
+import globals from "globals";
+import js from "@eslint/js";
+import eslintConfigPrettier from "eslint-config-prettier";
+
+export default [
+  { languageOptions: { globals: globals.browser } },
+  js.configs.recommended,
+  eslintConfigPrettier,
+];

data/lib/install/prettier/prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "printWidth": 100
+}

data/lib/install.rb

@@ -0,0 +1,27 @@
+say "Install eslint and prettier"
+run "#{Jslinting.package_manager} add -D eslint @eslint/js eslint globals prettier eslint-config-prettier"
+
+say "Setup eslint"
+copy_file "#{__dir__}/install/eslint/eslint.config.mjs", "eslint.config.mjs"
+copy_file "#{__dir__}/install/prettier/prettierrc.json", ".prettierrc"
+
+say "Add scripts"
+lint_script = "eslint app/javascript --max-warnings 0 && prettier app/javascript --check"
+format_script = "eslint app/javascript --fix && prettier app/javascript --write"
+
+case `npx -v`.to_f
+when 7.1...8.0
+  run %(npm set-script lint "#{lint_script}")
+  run %(npm set-script format "#{format_script}")
+
+  say "Formating..."
+  run "#{Jslinting.package_manager} run format"
+when (8.0..)
+  run %(npm pkg set scripts.lint="#{lint_script}")
+  run %(npm pkg set scripts.format="#{format_script}")
+
+  say "Formating..."
+  run "#{Jslinting.package_manager} run format"
+else
+  say %(Add "scripts": { "lint": "#{lint_script}", "format": "#{format_script}" } to your package.json), :green
+end

data/lib/jslinting/engine.rb

@@ -0,0 +1,4 @@
+module Jslinting
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/jslinting/version.rb

@@ -0,0 +1,3 @@
+module Jslinting
+  VERSION = "0.1.1"
+end

data/lib/jslinting-rails.rb

@@ -0,0 +1,21 @@
+module Jslinting
+  def self.package_manager
+    case
+    when File.exist?("bun.lockb") then :bun
+    when File.exist?("yarn.lock") then :yarn
+    when File.exist?("pnpm-lock.yaml") then :pnpm
+    when File.exist?("package-lock.json") then :npm
+    when pm_exists?("bun") then :bun
+    when pm_exists?("yarn") then :yarn
+    when pm_exists?("pnpm") then :pnpm
+    when pm_exists?("npm") then :npm
+    end
+  end
+
+  def self.pm_exists?(pm)
+    system "which #{pm} > /dev/null"
+  end
+end
+
+require "jslinting/version"
+require "jslinting/engine"

data/lib/tasks/jslinting/install.rake

@@ -0,0 +1,6 @@
+namespace :jslinting do
+  desc "Install and setup JavaScript linting"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install.rb", __dir__)}"
+  end
+end

data/lib/tasks/jslinting/lint.rake

@@ -0,0 +1,39 @@
+namespace :javascript do
+  desc "Lint your JavaScript"
+  lint_task = task :lint do
+    command = Jslinting::Tasks.lint_command
+    unless system(command)
+      raise "jslinting-rails: Command lint failed, ensure `#{command}` runs without errors"
+    end
+  end
+
+  lint_task.prereqs << :install unless ENV["SKIP_YARN_INSTALL"] || ENV["SKIP_BUN_INSTALL"]
+
+  desc "Format your JavaScript"
+  format_task = task :format do
+    command = Jslinting::Tasks.lint_command
+    unless system(command)
+      raise "jslinting-rails: Command format failed, ensure `#{command}` runs without errors"
+    end
+  end
+
+  format_task.prereqs << :install unless ENV["SKIP_YARN_INSTALL"] || ENV["SKIP_BUN_INSTALL"]
+end
+
+module Jslinting
+  module Tasks
+    extend self
+
+    def lint_command
+      return "#{Jslinting.package_manager} run lint" if Jslinting.package_manager.present?
+
+      raise "jslinting-rails: No JavaScript package manager found"
+    end
+
+    def format_command
+      return "#{Jslinting.package_manager} run format" if Jslinting.package_manager.present?
+
+      raise "jslinting-rails: No JavaScript package manager found"
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: jslinting-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ethan Kircher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email:
+- ethanmichaelk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/install.rb
+- lib/install/eslint/eslint.config.mjs
+- lib/install/prettier/prettierrc.json
+- lib/jslinting-rails.rb
+- lib/jslinting/engine.rb
+- lib/jslinting/version.rb
+- lib/tasks/jslinting/install.rake
+- lib/tasks/jslinting/lint.rake
+homepage: https://github.com/rails/jsbundling-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: Lint and format JavaScript in Rails with eslint and prettier
+test_files: []