ilib-lint 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,231 @@
+# ilib-lint
+
+A static analysis linter for many types of source files that looks for i18n problems.
+
+This i18n linter differs from other static linters in the following ways:
+
+* it can recognize the locale of files from the path name of files or from within
+  the file itself, and applies locale-sensitive rules. For example, you can apply
+  a rule that checks that the translations in a resource file of a plural resource
+  contain the correct set of plural categories for the target language.
+* it can apply different rulesets to different sets of files. This is useful for
+  a number of reasons:
+    * when linting a mono-repo that has different subprojects inside of it
+      and each subproject needs different rules applied to its files
+    * when different file types need different rulesets
+
+## Installation
+
+```
+npm install ilib-lint
+
+or
+
+yarn add ilib-lint
+```
+
+Then, in your package.json, add a script:
+
+```
+"scripts": {
+    "lint": "ilib-lint"
+}
+```
+
+Please note: nodejs version 14 or above is required to run this tool, as it
+is written with ESM modules.
+
+## Quick Start
+
+Running ilib-lint is easy. Just change your directory to the top level directory
+of your project and run it with no parameters and no configuration file. When
+there are no parameters and no configuration file, it will do all default
+behaviours, which for some projects is sufficient.
+
+The default behaviours are:
+
+* Start in the current directory and recursively find all files
+  and subdirectories underneath there
+* All built-in rules will be added to the current rule set
+* There are a few built-in
+  types of files handled and default rulesets that apply to them.
+* For each rule in a ruleset, it will use the default settings for that rule
+* It will use the default set of locales (the top 20 locales on the internet
+  by traffic) with "en-US" being the source locale
+* It will apply each rule in the current ruleset that applies to
+  each type of file. If a file type does not have any rulesets that apply to it,
+  it will be skipped.
+    * the locale of a file will be gleaned from its path name if possible
+    * for some types of resource files, the locale is documented in
+      the file itself. (eg. xliff files)
+* Output will be printed on the standard output in human readable form
+```
+$ cd myproject
+$ ilib-lint
+ilib-lint - Copyright (c) 2022 JEDLsoft, All rights reserved.
+WARN: i18n/ru_RU.properties(45): translation should use the appropriate
+quote style
+  myproject.dialog1.body.text = Нажмите кнопку "Справка", чтобы получить
+дополнительную информацию.
+  Rule (locale-quote-style): quote style for the the locale "ru-RU" should
+be «text»
+$
+```
+
+## Command-line Parameters
+
+ilib-lint accepts the following command-line parameters:
+
+* help - Print out a help message detailing these command-line parameters
+* config - Give an explicit path to a configuration file instead of trying to
+  find it in the current directory.
+* errorsOnly - Only give information on errors, not warnings. Also, only exit
+  with status 2 if there are errors, and status 0 if there are warnings. This
+  flag allows you to squelch the warnings and only fail a script if there are
+  actual errors.
+* locales - Locales you want your app to support. Value is a comma-separated
+  list of BCP-47 style locale tags.
+  Default: the top 20 locales on the internet by traffic.
+* sourceLocale - locale of the source files or the source locale for resource
+  files. Default: "en-US"
+* quiet - Produce no progress output during the run, except for errors running
+  the tool such as the inability to load a plugin. Instead exit with a return
+  value. Zero indicates no errors, and a positive exit value indicates errors.
+
+## Exit Status
+
+If you want to use this linter in a script, you can check for the following
+exit status:
+
+* 0 - no problems found
+* 1 - warnings found
+* 2 - errors found
+
+When the `--errorsOnly` flag is given, the program will return 0 if only
+warnings can be found or if no issues are found.
+
+## Configuration
+
+If the named paths contain a file called `ilib-lint-config.json`, it
+will be read and processed to configure the ilib-lint tool for that path. The
+`ilib-lint-config.json` file can have any of the following properties:
+
+* name (String) - name of this project
+* locales (Array of strings) - that name the default set of locales for the
+  whole project if they are not configured by each path
+* sourceLocale (String) - name the locale for source strings in this app.
+  Default if not specified is "en-US".
+* paths (Object) - a set of configurations for various paths that are given
+  by a [micromatch](https://github.com/micromatch/micromatch) glob expression.
+  Each glob expression property should be an object that contains settings
+  that apply to files that match the glob expression. The settings can be
+  be any of:
+    * locales (Array of strings) - a set of locales that override
+      the global locales list
+    * rules - (Object) a set of rules to use with this set of files.
+      Each rule name maps either to a boolean (true means turn it
+      on, and false means off) or to a string or object that gives
+      options for the rule. (Each rule can be different)
+    * rulesets (Array of strings) - list the names of rule sets to
+      turn on. Rulesets are groups of rules that are typically
+      bundled together for particular purpose, such as rules for a
+      particular library in a particular programming languages. For
+      example, you might have a "android-kotlin" ruleset that turns
+      on a number of rules that are typical for checking Android
+      apps written in Kotlin. If a ruleset is given, the
+      individual rules in that rule set can still be overridden using
+      the "rules" property above. Rulesets are just a short-hand
+      to turn on many of them at once.
+    * template (string) - a template that can be used to parse the
+      file name for the locale of that file.
+
+The `ilib-lint-config.json` file can be written in [JSON5](https://github.com/json5/json5)
+syntax, which means it can contain comments and other enhancements.
+
+### Example Config File
+
+Here is an example of a configuration file:
+
+```json
+{
+    "name": "tester",
+    "locales": [
+        "en-US",
+        "de-DE",
+        "ja-JP",
+        "ko-KR"
+    ],
+    "excludes": {
+        "node_modules/**",
+        ".git/**",
+        "test/**"
+    },
+    "paths": {
+        "src/**/*.json": {
+            // override the general locales
+            "locales": [
+                "en-US",
+                "de-DE",
+                "ja-JP"
+            ],
+            "rulesets": [
+                "javascript-ilib"
+            ]
+        },
+        // check the translations from the translation vendor before
+        // we use them in our project
+        "**/*.xliff": {
+            "rules": {
+                "formatjs-plural-syntax": true,
+                "formatjs-plural-categories": true,
+                "formatjs-match-substitution-params": true,
+                "match-quote-style": "localeOnly"
+            }
+        }
+    }
+}
+```
+
+## Built-in Rules
+
+Some generic rules that apply to many types of files are built-in to ilib-lint.
+This apply mostly to resource files, such as XLIFF files.
+
+The built-in rules are:
+
+- resource-icu-plurals - check for ICU-style plurals. Also works with formatjs
+  plurals, as it has the same syntax.
+- resource-quote-style - if the source string has quotes, check that the target
+  string also has quotes and that those quotes are appropriate for the locale
+- resource-url-match - if the source string contains references to URLs, check
+  that the target string also contains references to the same URLs
+- resource-named-params - Ensure that named parameters that appear in the source
+  string are also used in the translated string
+- resource-unique-key - Ensure that the keys are unique within a locale across
+  all resource files
+
+## License
+
+Copyright © 2022, JEDLSoft
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+See the License for the specific language governing permissions and
+limitations under the License.
+
+## Release Notes
+
+### v1.0.0
+
+- initial version
+- define initial code and default built-in rules
+- this is an ESM-only project, which is why it can only be run with
+  nodejs v14+