@j-ulrich/release-it-regex-bumper 3.0.0 → 4.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 Jochen Ulrich
+Copyright (c) 2020-2022 Jochen Ulrich
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -3,8 +3,8 @@
 > Regular expression based version read/write plugin for release-it
 
 ![CI](https://github.com/j-ulrich/release-it-regex-bumper/workflows/CI/badge.svg)
-[![Test Coverage](https://app.codacy.com/project/badge/Coverage/bf3c6e8740a9472b9acd7dac231adf4e)](https://www.codacy.com/manual/j-ulrich/release-it-regex-bumper?utm_source=github.com&utm_medium=referral&utm_content=j-ulrich/release-it-regex-bumper&utm_campaign=Badge_Coverage)
-[![Code Quality](https://app.codacy.com/project/badge/Grade/bf3c6e8740a9472b9acd7dac231adf4e)](https://www.codacy.com/manual/j-ulrich/release-it-regex-bumper?utm_source=github.com&utm_medium=referral&utm_content=j-ulrich/release-it-regex-bumper&utm_campaign=Badge_Grade)
+[![Test Coverage](https://app.codacy.com/project/badge/Coverage/bf3c6e8740a9472b9acd7dac231adf4e)](https://www.codacy.com/gh/j-ulrich/release-it-regex-bumper/dashboard?utm_source=github.com&utm_medium=referral&utm_content=j-ulrich/release-it-regex-bumper&utm_campaign=Badge_Coverage)
+[![Code Quality](https://app.codacy.com/project/badge/Grade/bf3c6e8740a9472b9acd7dac231adf4e)](https://www.codacy.com/gh/j-ulrich/release-it-regex-bumper/dashboard?utm_source=github.com&utm_medium=referral&utm_content=j-ulrich/release-it-regex-bumper&utm_campaign=Badge_Grade)
 
 This [release-it](https://github.com/release-it/release-it) plugin reads and/or writes versions
 using regular expressions.
@@ -18,6 +18,10 @@ below for details.
 
 # Installation #
 
+> ⚠️ **Note:**  
+> Version 4 and later of release-it-regex-bumper require version 15 or later of release-it.   
+> When you are using release-it version 14.x or earlier, then use release-it-regex-bumper version 3.x or earlier.
+
 ```
 npm install --save-dev @j-ulrich/release-it-regex-bumper
 ```
@@ -40,7 +44,7 @@ For example:
                 {
                     "file": "README.md",
                     "search": "Version \\d+\\.\\d+\\.\\d+",
-                    "replace": "Version {{version}}"
+                    "replace": "Version {{versionWithoutPrerelease}}"
                 }
             ]
         }
@@ -48,7 +52,7 @@ For example:
 }
 ```
 
-For a more complex example, see [here](https://gitlab.com/julrich/MockNetworkAccessManager/-/blob/b31fd6d956ab0f61c1017432265e9e1c99a17bee/.release-it.json).
+For a more complex example, see [here](https://gitlab.com/julrich/MockNetworkAccessManager/-/blob/main/.release-it.json).
 
 
 ## Regular Expressions ##
@@ -64,7 +68,8 @@ example, the pattern `\d+` needs to be written as `"\\d+"` inside JSON.
 
 ## Configuration Options ##
 
-> ℹ️ **Note:** Options without a default value are required.
+> ℹ️ **Note:**    
+> Options without a default value are required.
 
 ### `in` ###
 
@@ -117,7 +122,7 @@ Capturing groups can be used to extract the version from a part of the whole mat
 documentation of the configuration option `in.search.versionCaptureGroup` for a description of the
 handling of capturing groups.
 
-The `in.search.pattern` also supports a set of placeholders (since version 2.1.0):
+The `in.search.pattern` also supports a set of placeholders (since version 3.0.0):
 
 - `{{semver}}` is matching any version string complying to the semantic versioning specification (meaning at least
   "major.minor.patch").
@@ -128,8 +133,8 @@ The `in.search.pattern` also supports a set of placeholders (since version 2.1.0
 - `{{{}}` is matching a literal `{`. This can be used to match a literal placeholder.    
   For example: `{{{}}{foo}}` is matching `{{foo}}`
 
-> ℹ️ **Note:** All the placeholders are contained in a non-capturing group (`(?:...)`) so they behave like "atomic"
-  constructs.
+> ℹ️ **Note:**    
+> All the placeholders are contained in a non-capturing group (`(?:...)`) so they behave like "atomic" constructs.
 
 ### `in.search.flags` ###
 
@@ -138,6 +143,8 @@ The `in.search.pattern` also supports a set of placeholders (since version 2.1.0
 
 The flags for the regular expression `in.search.pattern`.
 
+If this option is `null` or not defined, the [global `search.flags`](#searchflags) are used.
+
 ### `in.search.versionCaptureGroup` ###
 
 **Type:** `integer|string`    
@@ -258,7 +265,7 @@ In contrast to `in.search.pattern`, capturing groups are not treated special in
 If this option is `null` or not defined, the [global `search`](#search) resp.
 [global `search.pattern`](#searchpattern) is used.
 
-The `out.search.pattern` also supports a set of placeholders (since version 2.1.0):
+The `out.search.pattern` also supports a set of placeholders (since version 3.0.0):
 
 - `{{version}}` is matching the current version (before the increment).
 - `{{major}}` is matching the major part of the current version.
@@ -274,6 +281,8 @@ The `out.search.pattern` also supports a set of placeholders (since version 2.1.
   does not have a build part, it is omitted (matching empty string).
 - `{{versionWithoutBuild}}` is matching the current version without the build part.
 - `{{versionWithoutPrerelease}}` is matching the current version without the prerelease and build parts.
+- `{{tag}}` is matching the current VCS tag (before the bump).
+- `{{newVersion}}` is matching the new version (after the increment).
 - `{{semver}}` is matching any version string complying to the semantic versioning specification (meaning at least
   "major.minor.patch").
 - `{{now:<format>}}` is matching the current timestamp in a format specified by the `<format>` parameter.
@@ -283,8 +292,8 @@ The `out.search.pattern` also supports a set of placeholders (since version 2.1.
 - `{{{}}` is matching a literal `{`. This can be used to match a literal placeholder.    
   For example: `{{{}}{foo}}` is matching `{{foo}}`
 
-> ℹ️ **Note:** All the placeholders are contained in a non-capturing group (`(?:...)`) so they behave like "atomic"
-  constructs.
+> ℹ️ **Note:**    
+> All the placeholders are contained in a non-capturing group (`(?:...)`) so they behave like "atomic" constructs.
 
 ### `out.search.flags` ###
 
@@ -322,13 +331,13 @@ The template string also supports a set of placeholders:
   Since: 1.2.0
 - `{{prefixedPrerelease}}` is replaced by a dash ('-') followed by the prerelease part of the new version or and empty
   string if the version does not have a prerelease part.    
-  Since: 2.1.0
+  Since: 3.0.0
 - `{{build}}` is replaced by the build part of the new version or an empty string if the version does not have a
   build part.    
   Since: 1.2.0
 - `{{prefixedBuild}}` is replaced by a plus ('+') followed by the build part of the new version or an empty string
   if the version does not have a build part.    
-  Since: 2.1.0
+  Since: 3.0.0
 - `{{versionWithoutBuild}}` is replaced by the new version without the build part.    
   Since: 1.2.0
 - `{{versionWithoutPrerelease}}` is replaced by the new version without the prerelease and build
@@ -367,7 +376,13 @@ If `search` is an object, it takes the following properties:
 **Default:** `"{{semver}}"`
 
 The default regular expression pattern template which is used when `in.search.pattern` or
-`out.search.pattern` is `null` or not defined. See `out.search.pattern` for more information.
+`out.search.pattern` is `null` or not defined. See [`in.search.pattern`](#insearchpattern) and
+[`out.search.pattern`](#outsearchpattern) for more information.
+
+> ⚠️ **Warning:**    
+> Note that the global `search.pattern` is used for both `in.search.pattern` and `out.search.pattern` unless
+> overridden explicitly. But `in.search.pattern` does not support all the placeholders of `out.search.pattern` and
+> using unsupported placeholders raises an error.
 
 If this option is not defined or set to `null`, the default value is used.
 
@@ -376,7 +391,8 @@ If this option is not defined or set to `null`, the default value is used.
 **Type:** `string`    
 **Default:** `null`
 
-The flags for the regular expression `search.pattern`.
+The default flags for the search pattern which are used when `in.search.flags` or
+`out.search.flags` are `null` or not defined.
 
 ### `search.versionCaptureGroup` ###
 
@@ -409,9 +425,18 @@ encodings are the ones supported by Node's `fs` module.
 
 If this option is not defined or set to `null`, the default value is used.
 
+## Tips ##
+
+### Disable Output via Command-Line Parameter ###
+To completely disable changing any files by the plugin, you can use the command-line parameter `--no-plugins.@j-ulrich/release-it-regex-bumper.out`.
+For example:
+```
+npx release-it --no-plugins.@j-ulrich/release-it-regex-bumper.out
+```
+
 
 # License #
 
-Copyright (c) 2020-2021 Jochen Ulrich
+Copyright (c) 2020-2022 Jochen Ulrich
 
 Licensed under [MIT license](LICENSE).