putout 31.2.4 → 31.3.0

package/ChangeLog

@@ -1,3 +1,14 @@
+2023.08.23, v31.3.0
+
+feature:
+- 783861f83 package: @putout/plugin-apply-entries v2.0.0
+- 137145031 putout: add putoutAsync
+- 347e572ad @putout/plugin-apply-entries: ESM
+- 66aecbf55 @putout/plugin-apply-namespace-specifier: create-test
+- e0be94d96 @putout/plugin-putout: apply-namespace-specifier: rules
+- 66434fb93 @putout/engine-loader: add loadPluginsAsync
+- 890558e38 eslint-plugin-putout: putout: esm
+
 2023.08.22, v31.2.4
 
 feature:

package/README.md

@@ -291,6 +291,28 @@ console.log(t);
 `;
 ```
 
+### putoutAsync(source, options)
+
+```js
+const {putoutAsync} = require('putout');
+
+const source = `
+    const t = 'hello';
+    const m = t + '!';
+    console.log(t);
+`;
+
+await putoutAsync(source, {
+    plugins: ['remove-unused-variables'],
+});
+
+// returns
+`
+const t = 'hello';
+console.log(t);
+`;
+```
+
 ## License
 
 MIT

package/lib/putout-async.js

@@ -0,0 +1,160 @@
+'use strict';
+
+const {traverse, types} = require('@putout/babel');
+
+const loader = require('@putout/engine-loader');
+const runner = require('@putout/engine-runner');
+
+const {
+    parse,
+    print,
+    generate,
+    template,
+} = require('@putout/engine-parser');
+
+const {cutShebang, mergeShebang} = require('./shebang');
+
+const isString = (a) => typeof a === 'string';
+
+const defaultOpts = (opts = {}) => {
+    const {
+        parser = 'babel',
+        printer = opts.printer || 'putout',
+        fix = true,
+        fixCount = 2,
+        loadPlugins = loader.loadPlugins,
+        loadPluginsAsync = loader.loadPluginsAsync,
+        runPlugins = runner.runPlugins,
+    } = opts;
+    
+    return {
+        ...opts,
+        parser,
+        printer,
+        fix,
+        fixCount,
+        loadPlugins,
+        loadPluginsAsync,
+        runPlugins,
+    };
+};
+
+module.exports.putoutAsync = async (source, opts) => {
+    check(source);
+    opts = defaultOpts(opts);
+    
+    const {
+        parser,
+        isTS,
+        isFlow,
+        isJSX,
+        sourceFileName,
+        sourceMapName,
+        printer,
+    } = opts;
+    
+    const [clearSource, shebang] = cutShebang(source);
+    
+    const ast = parse(clearSource, {
+        sourceFileName,
+        parser,
+        isTS,
+        isFlow,
+        isJSX,
+        printer,
+    });
+    
+    const places = await transform(ast, source, opts);
+    
+    if (!opts.fix)
+        return {
+            code: source,
+            places,
+        };
+    
+    const printed = print(ast, {
+        sourceMapName,
+        printer,
+    });
+    
+    const code = mergeShebang(shebang, printed);
+    
+    return {
+        code,
+        places,
+    };
+};
+
+module.exports.findPlaces = async (ast, source, opts) => {
+    return await transform(ast, source, {
+        ...opts,
+        fix: false,
+    });
+};
+
+// why we pass 'source' to 'transform()'?
+// because we need to calculate position in a right way
+// and determine is shebang is exists
+//
+// 25     return {¬
+// 26         line: shebang ? line + 1 : line,¬
+// 27         column,¬
+// 28     };¬
+//
+module.exports.transform = transform;
+async function transform(ast, source, opts) {
+    opts = defaultOpts(opts);
+    
+    const {
+        plugins: pluginNames,
+        cache,
+        rules,
+        fix,
+        fixCount,
+        loadPluginsAsync,
+        runPlugins,
+    } = opts;
+    
+    const [, shebang] = cutShebang(source);
+    
+    const plugins = await loadPluginsAsync({
+        pluginNames,
+        cache,
+        rules,
+    });
+    
+    const places = runPlugins({
+        ast,
+        shebang,
+        fix,
+        fixCount,
+        plugins,
+    });
+    
+    return places;
+}
+
+module.exports.parse = parse;
+module.exports.print = print;
+module.exports.traverse = traverse;
+module.exports.types = types;
+module.exports.template = template;
+module.exports.generate = generate;
+module.exports.initReport = require('./cli/report');
+
+module.exports.operator = {
+    ...require('@putout/operate'),
+    ...require('@putout/compare'),
+    ...require('@putout/traverse'),
+    ...require('@putout/operator-declare'),
+    ...require('@putout/operator-regexp'),
+    ...require('@putout/operator-add-args'),
+};
+
+module.exports.ignores = require('./ignores');
+module.exports.codeframe = require('./codeframe');
+
+function check(source) {
+    if (!isString(source))
+        throw Error(`☝️ Looks like 'source' has type '${typeof source}', expected: 'string'`);
+}

package/lib/putout.js

@@ -13,6 +13,7 @@ const {
 } = require('@putout/engine-parser');
 
 const {cutShebang, mergeShebang} = require('./shebang');
+const {putoutAsync} = require('./putout-async');
 
 const isString = (a) => typeof a === 'string';
 
@@ -83,6 +84,8 @@ module.exports = (source, opts) => {
     };
 };
 
+module.exports.putoutAsync = putoutAsync;
+
 module.exports.findPlaces = (ast, source, opts) => {
     return transform(ast, source, {
         ...opts,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "putout",
-  "version": "31.2.4",
+  "version": "31.3.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊 Pluggable and configurable code transformer with built-in ESLint, Babel and support of js, jsx, typescript, flow, markdown, yaml and json",
@@ -201,6 +201,7 @@
     "unused"
   ],
   "devDependencies": {
+    "@putout/plugin-apply-entries": "^2.0.0",
     "c8": "^8.0.0",
     "currify": "^4.0.0",
     "escover": "^3.2.2",