@hh.ru/babel-plugin-static-value-extractor - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

package.json

 {
   "name": "@hh.ru/babel-plugin-static-value-extractor",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "main": "lib/index.js",
@@ -5,0 +5,0 @@ "devDependencies": {

README.md

 # babel-plugin-static-value-extractor
 
+## Сервис содержит webpack обертку:
+
+[Линк на документацию вебпак обёртки.](src/static-value-extractor-plugin.md)
+
 ## Описание
 
-Плагин парсит jsx файлы, и извлекает необходимое значения статических свойств у классов или функций, которые представляют собой объект типа ключ - значение. Value парсятся если они имеют тип String.
-Переданный файл считается рутовым и все его импорты будут также распаршены и сохранены в внешний файл, по 
-необходимому шаблону.
+Плагин парсит jsx, tsx файлы, и извлекает необходимые значения статических свойств у классов или функций, которые представляют собой объект типа ключ - значение. Value парсятся если они имеют тип String.
 
@@ -13,9 +15,14 @@ ```
 ], {
-    staticPropName: — имя свойства
-    saveFileName: — имя файла
+    propsToExtract: 
+    { 
+        <имя файла> {
+            constantName: <имя свойства>
+        },
+        <...>   
+    }
     saveFilePath: — путь, куда сохранять значения свойств
-    saveFileExt: — расширение файла,
+    saveFileExt: — расширение файлов,
     pathsToReplace: — webpackAliases,
-    include: — массив строк путей файлов для которых нужно извлекать значения статических свойств,
-    template: — функция которая возвращает шаблон контента(string), в качестве аргумента передается объект с ключами названий Файлов и значением массивов извлеченных значений, если не передать контентом сохраненного файла будет JSON представление.',
+    include: — массив строк путей файлов, для которых нужно извлекать значения статических свойств,
+    template: — функция которая возвращает шаблон контента(string), в качестве аргумента передается объект с ключами названий Файлов и значением массивов извлеченных значений, если не передать - контентом сохраненного файла будет JSON представление.',
 });
@@ -32,3 +39,3 @@ ```
 ```sh
-$ yarn install babel-plugin-static-value-extractor
+$ yarn add @hh.ru/babel-plugin-static-value-extractor
 ```
@@ -41,14 +48,1 @@
  ```
-
-## Пример использования в Node окружении
-
-```javascript
-const extractStaticValueFromGlob = require('babel-parser-parse-static-trl');
-
-extractStaticValueFromGlob(['/Component/*.jsx'], {
-    staticPropName: 'customProps',
-    saveFileName: 'Component',
-    saveFilePath: 'customPath',
-    saveFileExt: 'js',
-});
-```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29556

increased by22.13%

Number of package files

10

increased by11.11%

Lines of code

481

increased by24.29%

Worsened metrics

Number of lines in readme file

46

decreased by-11.54%

No dependency changes