docs: rename plug-in, to plugin

Author: jonlabelle

.github/ISSUE_TEMPLATE/bug.yml

@@ -28,7 +28,7 @@ body:
   - type: input
     id: js_prettier_version
     attributes:
-      label: JsPrettier plug-in version
+      label: JsPrettier plugin version
       description: Located in the [package.json](https://github.com/jonlabelle/SublimeJsPrettier/blob/master/package.json#L3 "Go to version in package.json") file
       placeholder: 'x.x.x'
     validations:

CHANGELOG.md

@@ -43,7 +43,7 @@ Checkout what's new in [Prettier v2.4](https://prettier.io/blog/2021/09/09/2.4.0
 
 **Release Date:** 2021-07-14
 
-Config and executable paths are no longer cached by the plug-in.
+Config and executable paths are no longer cached by the plugin.
 Path resolution/discovery caching now differed to Prettier when applicable.
 
 ## 1.38.0
@@ -151,7 +151,7 @@ Tab trigger is `pi`.
   forcefully terminated.
 
   To avoid this problematic behavior, or until the defect is resolved, you can
-  disable the plug-in (JsPrettier) from ever passing the cursor offset
+  disable the plugin (JsPrettier) from ever passing the cursor offset
   position to Prettier by setting the `disable_prettier_cursor_offset` value
   to `true`.
 
@@ -202,7 +202,7 @@ Tab trigger is `pi`.
 **Release Date:** 2019-01-21
 
 - Added setting to `disable_tab_width_auto_detection` (default is `false`);
-  which disables the default behavior of the plug-in automatically setting
+  which disables the default behavior of the plugin automatically setting
   Prettier's "tabWidth" option (at runtime) with the SublimeText configured
   value for "tab_size".
 

JsPrettier.py

@@ -596,7 +596,7 @@ def parse_prettier_options(self, view, parsed_additional_cli_args, prettier_conf
             if option_name == 'editorconfig':
                 if str(option_value).lower() == 'false':
                     # only include negated editorconfig option, since default is already true
-                    # and can otherwise break prettier-eslint plug-in, see #235
+                    # and can otherwise break prettier-eslint plugin, see #235
                     prettier_options.append("--no-editorconfig")
                 continue
 
@@ -642,7 +642,7 @@ def parse_prettier_options(self, view, parsed_additional_cli_args, prettier_conf
 
         if debug_enabled(view):
             if not parsed_additional_cli_args.count('--log-level') > 0:
-                # set prettier's log level to debug, when the plug-in's debug setting is enabled:
+                # set prettier's log level to debug, when the plugin's debug setting is enabled:
                 prettier_options.append('--log-level')
                 prettier_options.append('debug')
 

JsPrettier.sublime-settings

@@ -35,7 +35,7 @@
 	// 1. Locally installed prettier relative to active view.
 	// 2. Locally installed prettier relative to the Sublime Text Project file's root directory. e.g.: `node_modules/.bin/prettier` and `node_modules/prettier/bin-prettier.js`.
 	// 3. The current user home directory. e.g.: `$HOME/node_modules/.bin/prettier`.
-	// 4. JsPrettier Sublime Text plug-in directory.
+	// 4. JsPrettier Sublime Text plugin directory.
 	// 5. Globally installed prettier.
 	//
 	// macOS and Linux examples:
@@ -217,7 +217,7 @@
 	// forcefully terminated.
 	//
 	// To avoid this problematic behavior, or until the defect is resolved, you
-	// can disable the plug-in (JsPrettier) from ever passing the cursor offset
+	// can disable the plugin (JsPrettier) from ever passing the cursor offset
 	// position to Prettier by setting the `disable_prettier_cursor_offset` value to `true`.
 	//
 	// Related Issues:
@@ -383,7 +383,7 @@
 		// Which parser to use. Valid options are "flow", "babel",
 		// "typescript", "css", "json", "graphql", "markdown" and "yaml".
 		//
-		// NOTE: The `parser` option is automatically set by the plug-in
+		// NOTE: The `parser` option is automatically set by the plugin
 		// (JsPrettier), based on the contents of current file or selection.
 		// --------------------------------------------------------------------
 

README.md

@@ -5,7 +5,7 @@
 [![Latest Release](https://img.shields.io/github/v/tag/jonlabelle/SublimeJsPrettier.svg?label=version&sort=semver)](https://github.com/jonlabelle/SublimeJsPrettier/tags)
 [![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/jonlabelle/SublimeJsPrettier/blob/master/LICENSE)
 
-> [JsPrettier] is a Sublime Text Plug-in for [Prettier], the opinionated code
+> [JsPrettier] is a Sublime Text Plugin for [Prettier], the opinionated code
 > formatter.
 
 [![Before and After JsPrettier](https://github.com/jonlabelle/SublimeJsPrettier/blob/master/screenshots/before_and_after.gif?raw=true)](https://github.com/jonlabelle/SublimeJsPrettier/blob/master/screenshots/demo.gif)
@@ -25,12 +25,12 @@
     - [Install JsPrettier Using Git](#install-jsprettier-using-git)
 - [Usage](#usage)
     - [Command Scope](#command-scope)
-- [Plug-in Settings and Prettier Options](#plug-in-settings-and-prettier-options)
-    - [Plug-in Settings](#plug-in-settings)
+- [Plugin Settings and Prettier Options](#plugin-settings-and-prettier-options)
+    - [Plugin Settings](#plugin-settings)
     - [Prettier Options](#prettier-options)
     - [Project-level Settings](#project-level-settings)
     - [Prettier Configuration Files](#prettier-configuration-files)
-- [Prettier Plug-in Support](#prettier-plugin-support)
+- [Prettier Plugin Support](#prettier-plugin-support)
     - [Prettier PHP](#prettier-php)
     - [Prettier Community Plugins](#prettier-community-plugins)
 - [Issues](#issues)
@@ -143,17 +143,17 @@ navigating to `Preferences -> Key Bindings` and add the following configuration:
 { "keys": ["ctrl+alt+f"], "command": "js_prettier" }
 ```
 
-## Plug-in Settings and Prettier Options
+## Plugin Settings and Prettier Options
 
-Configure plug-in settings and Prettier options via the application menu:
+Configure plugin settings and Prettier options via the application menu:
 
 - **Preferences**
     - **Package Settings**
         - **JsPrettier**
             - **Settings - Default** (to view the defaults)
             - **Settings - User** (to override the defaults)
 
-### Plug-in Settings
+### Plugin Settings
 
 - **debug** (default: ***false***)  
     When enabled (*true*), debug info will print to the console - useful for
@@ -164,13 +164,13 @@ Configure plug-in settings and Prettier options via the application menu:
 
 - **prettier_cli_path** (default: ***empty***)  
     If Sublime Text has problems automatically resolving a path to [Prettier],
-    you can set a custom path here. When the setting is empty, the plug-in will
+    you can set a custom path here. When the setting is empty, the plugin will
     attempt to find Prettier by:
 
     1. Locally installed prettier relative to active view.
     2. Locally installed prettier relative to the Sublime Text Project file's root directory.
     3. The current user home directory.
-    4. JsPrettier Sublime Text plug-in directory.
+    4. JsPrettier Sublime Text plugin directory.
     5. Globally installed prettier.
 
     **Examples:**
@@ -266,7 +266,7 @@ Configure plug-in settings and Prettier options via the application menu:
     file size checking (default).
 
 - **disable_tab_width_auto_detection** (default: ***false***)  
-    Whether or not to disable the plug-in from automatically setting Prettier's
+    Whether or not to disable the plugin from automatically setting Prettier's
     [--tab-width](https://prettier.io/docs/en/options.html#tab-width)
     option, and adhere to the Prettier configured setting.
 
@@ -279,7 +279,7 @@ Configure plug-in settings and Prettier options via the application menu:
     forcefully terminated.
 
     To avoid this problematic behavior, or until the defect is resolved, you can
-    disable the plug-in (JsPrettier) from ever passing the cursor offset
+    disable the plugin (JsPrettier) from ever passing the cursor offset
     position to Prettier by setting the `disable_prettier_cursor_offset` value
     to `true`.
 
@@ -347,7 +347,7 @@ Configure plug-in settings and Prettier options via the application menu:
     Use single quotes instead of double quotes in JSX.
 
 - **parser** (default: "***babel***")  
-    The [`parser`] is automatically set by the plug-in (JsPrettier), based
+    The [`parser`] is automatically set by the plugin (JsPrettier), based
     on the contents of current file or selection.
 
 - **semi** (default: ***true***)  
@@ -475,7 +475,7 @@ See the Prettier Options [doc page] for more details and examples.
 
 JsPrettier supports [project-level settings], specified in `<project_name>.sublime-project` files.
 
-To override [previous configurations](#plug-in-settings-and-prettier-options) with your project-level settings,
+To override [previous configurations](#plugin-settings-and-prettier-options) with your project-level settings,
 add a new `js_prettier` key and section under `settings` as shown in the [example below](#example-sublime-text-project-file).
 
 #### Example Sublime Text Project File
@@ -564,7 +564,7 @@ and tell Prettier not to attempt to find config files.
 #### Prettier Ignore Config File Discovery (`.prettierignore`)
 
 When the [`--ignore-path`] option is NOT specified in `additional_cli_args`,
-the plug-in will search for a `.prettierignore` file in the same directory of
+the plugin will search for a `.prettierignore` file in the same directory of
 the source file, then the active Sublime Text project's root directory. If
 neither path can be resolved, search up the directory tree, and finally look
 in the user's home directory.

jsprettier/sthelper.py

@@ -155,7 +155,7 @@ def resolve_prettier_cli_path(view, plugin_path, st_project_path):
     2. Locally installed prettier, relative to a Sublime Text Project
       file's root directory, e.g.: `node_modules/.bin/prettier' and 'node_modules/prettier/bin-prettier.js';
     3. User's $HOME/node_modules directory.
-    4. Look in the JsPrettier Sublime Text plug-in directory for `node_modules/.bin/prettier`.
+    4. Look in the JsPrettier Sublime Text plugin directory for `node_modules/.bin/prettier`.
     5. Finally, check if prettier is installed globally.
 
     :return: The prettier cli path.

messages/1.22.0.txt

@@ -3,6 +3,6 @@
 Release Date: 2019-01-21
 
 - Added setting to `disable_tab_width_auto_detection` (default is `false`);
-  which disables the default behavior of the plug-in automatically setting
+  which disables the default behavior of the plugin automatically setting
   Prettier's "tabWidth" option (at runtime) with the SublimeText configured
   value for "tab_size".

messages/install.txt

@@ -5,7 +5,7 @@
 │                | |_| \__ \  __/| | |  __/ |_| |_| |  __/ |                 │
 │                 \___/|___/_|   |_|  \___|\__|\__|_|\___|_|                 │
 │                                                                            │
-│     Sublime Text Plug-in for Prettier, the opinionated code formatter.     │
+│     Sublime Text Plugin for Prettier, the opinionated code formatter.     │
 └────────────────────────────────────────────────────────────────────────────┘
 
 ## Getting started
@@ -50,7 +50,7 @@ There are three ways to format code...
 
 3. Key Binding
 
-    There is no default key binding for this plug-in.
+    There is no default key binding for this plugin.
 
     To add a key binding, navigate to "Preferences" -> "Key Bindings...", and
     add an entry for "js_prettier". For example...

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sublime-js-prettier",
   "version": "1.68.2",
-  "description": "JsPrettier is a Sublime Text Plug-in for Prettier, the opinionated code formatter.",
+  "description": "JsPrettier is a Sublime Text Plugin for Prettier, the opinionated code formatter.",
   "author": "Jon LaBelle",
   "license": "MIT",
   "dependencies": {

tests/test_json.py

@@ -9,26 +9,42 @@
 
 class TestSettings(unittest.TestCase):
     def _get_json_files(self, file_pattern, folder='.'):
+        """
+        Recursively yield file paths matching the given pattern within the specified folder.
+        """
         for root, dirnames, filenames in os.walk(folder):
             for filename in fnmatch.filter(filenames, file_pattern):
                 yield os.path.join(root, filename)
             for dirname in [d for d in dirnames
-                            if d not in ('.cache', '.git', '.github', '.idea',
-                                         'messages', 'screenshots', 'scripts', os.path.join('tests', '__pycache__'))]:
+                            if d not in (
+                                '.cache',
+                                '.git',
+                                '.github',
+                                '.idea',
+                                'jsprettier',
+                                'messages',
+                                'node_modules',
+                                'screenshots',
+                                'scripts',
+                                'Snippets',
+                                'tests',
+                                'venv',
+                                os.path.join('tests', '__pycache__')
+                            )]:
                 for f in self._get_json_files(file_pattern, os.path.join(root, dirname)):
                     yield f
 
     def test_json_settings(self):
-        """Test each JSON file."""
+        """
+        Test each JSON file to ensure it conforms to the expected format.
+        """
         file_patterns = (
-            '*.json',
             '*.sublime-commands',
             '*.sublime-menu',
-            '*.sublime-settings',
-            '.markdownlintrc'
+            '*.sublime-settings'
         )
         for file_pattern in file_patterns:
             for f in self._get_json_files(file_pattern):
                 print(f)
                 self.assertFalse(validate_json_format.CheckJsonFormat(False, True).check_format(f),
-                                 "%s does not comform to expected format!" % f)
+                                 "%s does not conform to expected format." % f)