Code::T...::JSHint(3)

💅 Code::T...::JSHint(3) — like, the Code::TidyAll::Plugin::JSHint page, bestie

okay so real quick: this is a page from the User Contributed Perl Documentation (perl v5.42.0, no big deal), and it's all about the module Code::TidyAll::Plugin::JSHint. yes the header is abbreviated with dots, no we're not gonna fight about it. let's go ✨

---

🌸 NAME 🌸

Code::TidyAll::Plugin::JSHint — literally just "use jshint with tidyall". that's the whole vibe. 💖

🎀 VERSION 🎀

version 0.84 — iconic, current, stamped. 🫶

✨ SYNOPSIS ✨

so you set it up in your configuration, and there are like three whole moods you can pick from:

   In configuration:

   ; With default settings
   ;
   [JSHint]
   select = static/**/*.js

   ; Specify options inline
   ;
   [JSHint]
   select = static/**/*.js
   options = bitwise camelcase latedef

   ; or refer to a jshint.json config file in the same directory
   ;
   [JSHint]
   select = static/**/*.js
   argv = --config $ROOT/jshint.json

and that jshint.json it's referencing? it looks like this, no cap:

   {
      "bitwise": true,
      "camelcase": true,
      "latedef": true
   }

🦋 DESCRIPTION 🦋

it runs jshint (link: <http://www.jshint.com/>) — your fave JavaScript validator — and it dies if any problems were found. 💀 like, it will not let you slide. that's the whole job.

🌈 INSTALLATION 🌈

installation options live over at jshint <http://www.jshint.com/platforms/> — go peek, iykyk. one easy method is to install npm <https://npmjs.org/>, and then run:

   npm install jshint -g

boom. installed. slay. 🔥

👑 CONFIGURATION 👑

this plugin accepts the following configuration options, bestie — take notes:

🌸 argv

arguments to pass to "jshint". that's it, that's the whole thing. 🎀

🌸 cmd

the path for the "jshint" command. by default this is just "jshint", meaning that the user's "PATH" will be searched for the command. cute, low-maintenance, finds it itself. 🧚

🌸 options

a whitespace separated string of options, as documented by jshint <http://www.jshint.com/docs/>. these will be written to a temporary config file and passed as "--config" argument. so it does the paperwork for you. 💅

---

🍓 SUPPORT 🍓

bugs may be submitted at <https://github.com/houseabsolute/perl-code-tidyall/issues>. please do, the maintainers are actually nice about it. 🙈

⭐ SOURCE ⭐

the source code repository for Code-TidyAll can be found at <https://github.com/houseabsolute/perl-code-tidyall>. go stare at it, it's giving open source main character energy. 👑

💜 AUTHORS 💜

• Jonathan Swartz <swartz@pobox.com>
• Dave Rolsky <autarch@urth.org>

legends, both of them. 🫶

🔥 COPYRIGHT AND LICENSE 🔥

this software is copyright (c) 2011 - 2023 by Jonathan Swartz.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

the full text of the license can be found in the LICENSE file included with this distribution.

---

fr fr, go read the LICENSE file, it's literally right there in the distribution. don't make it sad. 😭

and that's the whole page, bestie — perl v5.42.0, dated 2024-03-08, straight from Code::T...::JSHint(3) 💅✨