goldstein 3.0.0 → 3.2.0

package/ChangeLog

@@ -1,3 +1,14 @@
+2023.04.18, v3.2.0
+
+feature:
+- 76a336d golstein: add support of CommonJS
+
+2023.04.18, v3.1.0
+
+feature:
+- 4236346 goldstein: add ability to use arrow in FunctionDeclaration
+- 8e2197f goldstein: add ability tot pass keywords and 🐊Putout optionts
+
 2023.04.02, v3.0.0
 
 feature:

package/README.md

@@ -36,10 +36,10 @@ export fn hello() {
 $ gs 1.gs
 $ cat 1.js
 function hello() {
-  return "world";
+    return "world";
 }
 export {
-  hello
+    hello,
 };
 ```
 
@@ -99,9 +99,56 @@ function hello() {
 `;
 ```
 
+By default, all keywords mentioned in the next section used, but you can limit the list setting with `keywords` option.
+You can add any keywords, and even create your own:
+
+```js
+import {
+    compile,
+    keywords,
+} from 'goldstein';
+
+const source = `
+    fn hello() {
+        return id('hello');
+    }
+`;
+
+const {keywordFn} = keywords;
+
+compile(source, {
+    keywords: [
+        keywordFn,
+        function id(Parser) {
+            const {keywordTypes} = Parser.acorn;
+            return class extends Parser {
+            };
+        },
+    ],
+    rules: {
+        declare: ['on', {
+            declarations: {
+                id: 'const id = (a) => a',
+            },
+        }],
+    },
+});
+
+// returns
+`
+const id = (a) => a;
+
+function hello() {
+    return id('hello');
+}
+`;
+```
+
+You can declare variables with [`@putout/operator-declare`](https://github.com/coderaiser/putout/tree/master/packages/operator-declare).
+
 ### `parse(source)`
 
-When you need to get **JavaScript** ESTree AST use `parse`:
+When you need to get **JavaScript** Babel AST use `parse`:
 
 ```js
 import {parse} from 'goldstein';
@@ -115,7 +162,8 @@ parse(`
         return "Hello " + text
     }
 `);
-// returns ESTree AST
+
+// returns Babel AST
 ```
 
 ## Keywords
@@ -282,6 +330,22 @@ Will be converted to:
 import hello from './hello.js';
 ```
 
+### `FunctionDeclaration` with `Arrow`
+
+If you mistakenly put `=>` in function declaration:
+
+```gs
+function hello() => {
+}
+```
+
+That absolutely fine, it will be converted to:
+
+```js
+function hello() {
+}
+```
+
 ## How to contribute?
 
 Clone the registry, create a new keyword with a prefix `keyword-`, then create directory `fixture` and put there two files with extensions `.js` and `.gs`. Half way done 🥳!