@tony.ganchev/eslint-plugin-header 3.2.2 → 3.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +25 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -843,6 +843,27 @@ confusing configuration properties.
843
843
  Overall, the configuration tends to be noisier nad harder to read than that of
844
844
  _\@tony.ganchev/eslint-plugin-header_.
845
845
 
846
+ _eslint-plugin-headers_'s error reporting is rudimentary - either the header
847
+ passes or it fails and with complex templates you get no idea what the issue is.
848
+ Granted this is the case with _eslint-plugin-header_ but we spent many hours
849
+ improving this and the side by side comparison is telling.
850
+
851
+ _eslint-plugin-headers_ does not offer TypeScript bindings for its
852
+ configuration format making it slower to author configuration.
853
+ _\@tony.ganchev/eslint-plugin-header_ as often as possible reports which line
854
+ is problematic and starting from which character.
855
+
856
+ _eslint-plugin-headers_ supports some level of partial auto-fixes such as
857
+ replacing company names but not years. Or keeping JSDoc variables after the
858
+ copyright notice within the same comment. Some cases can be supported by
859
+ _\@tony.ganchev/eslint-plugin-header_ but in general our design has shied away
860
+ from touching existing comments to provide "smart" fixes. This is the current
861
+ state of the feature set yet the team is looking for the right model to bridge
862
+ the functionality gaps.
863
+
864
+ We have prepared a detailed [migration guide](docs/migrate-from-headers.md) for
865
+ anyone eager to migrate to _\@tony.ganchev/eslint-plugin-header_.
866
+
846
867
  #### Health Scans
847
868
 
848
869
  - _\@tony.ganchev/eslint-plugin-header_</th> -
@@ -865,6 +886,10 @@ This on one hand leads to it having a nice, dead-simple configuration, but means
865
886
  no complex multi-year project would be happy with it. Surprisingly, given the
866
887
  limited feature set, the plugin has more peer dependencies than the competition.
867
888
 
889
+ We have prepared a detailed
890
+ [migration guide](docs/migrate-from-license-header.md) for anyone eager to
891
+ migrate to _\@tony.ganchev/eslint-plugin-header_.
892
+
868
893
  ## Versioning
869
894
 
870
895
  The project follows standard [NPM semantic versioning policy](
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tony.ganchev/eslint-plugin-header",
3
- "version": "3.2.2",
3
+ "version": "3.2.3",
4
4
  "description": "The native ESLint 9/10 header plugin. A zero-bloat, drop-in replacement for 'eslint-plugin-header' with first-class Flat Config & TypeScript support. Auto-fix Copyright, License, and banner comments in JavaScrip and TypeScript files.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",