@mutates/core 1.0.1 → 1.2.0

package/README.md

@@ -1,3 +1,73 @@
 # @mutates/core
 
-[WIP]
+🔧 **@mutates/core** is the essential package of the Mutates toolset, providing the core
+functionality to manipulate the Abstract Syntax Tree (AST) of TypeScript files. It serves as the
+backbone for other specialized packages within the Mutates ecosystem.
+
+## Features
+
+- **AST Manipulation:** Modify the AST of any TypeScript file with ease.
+- **TypeScript Focused:** Specifically designed for TypeScript, ensuring optimal integration and
+  performance.
+- **Extensible:** Can be extended with framework-specific packages for additional functionality.
+
+## Installation
+
+To install the core package, use the following command:
+
+```sh
+npm install @mutates/core
+```
+
+## Usage
+
+### Basic Example
+
+Here is a simple example demonstrating how to use `@mutates/core` to modify a TypeScript file:
+
+```typescript
+import { addFunctions, creataProject, createSourceFile, saveProject } from '@mutates/core';
+
+// Initialize a new project
+createProject();
+
+// Add a TypeScript file to the project
+createSourceFile(
+  'example.ts',
+  `
+  const greet = (name: string) => {
+    return 'Hello, ' + name;
+  };
+`,
+);
+
+// Perform some transformations
+addFunctions('example.ts', {
+  name: 'farewell',
+  isExported: true,
+  statements: "return 'buy!'",
+});
+
+// Save the modified file
+saveProject();
+```
+
+## API Reference
+
+For a comprehensive guide on the available APIs and their usage, please refer to the
+[official documentation](https://mutates.katsuba.dev/packages/core)
+
+## Contributing
+
+🤝 Contributions are welcome! If you have any improvements or suggestions, feel free to open an
+issue or submit a pull request.
+
+## License
+
+📄 `@mutates/core` is licensed under the Apache-2.0 License. See the
+[LICENSE](https://github.com/ikatsuba/mutates/blob/main/LICENSE) file for more information.
+
+---
+
+For further assistance or to report issues, please visit our
+[GitHub repository](https://github.com/ikatsuba/mutates).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mutates/core",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "keywords": [
     "typescript",
     "ast",

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from './lib/accessors';
+export * from './lib/arrays';
 export * from './lib/classes';
 export * from './lib/constructors';
 export * from './lib/decorators';
@@ -6,6 +7,7 @@ export * from './lib/enums';
 export * from './lib/exports';
 export * from './lib/fs/file-system';
 export * from './lib/functions';
+export * from './lib/helpers';
 export * from './lib/imports';
 export * from './lib/interfaces';
 export * from './lib/methods';

package/src/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./lib/accessors"), exports);
+tslib_1.__exportStar(require("./lib/arrays"), exports);
 tslib_1.__exportStar(require("./lib/classes"), exports);
 tslib_1.__exportStar(require("./lib/constructors"), exports);
 tslib_1.__exportStar(require("./lib/decorators"), exports);
@@ -9,6 +10,7 @@ tslib_1.__exportStar(require("./lib/enums"), exports);
 tslib_1.__exportStar(require("./lib/exports"), exports);
 tslib_1.__exportStar(require("./lib/fs/file-system"), exports);
 tslib_1.__exportStar(require("./lib/functions"), exports);
+tslib_1.__exportStar(require("./lib/helpers"), exports);
 tslib_1.__exportStar(require("./lib/imports"), exports);
 tslib_1.__exportStar(require("./lib/interfaces"), exports);
 tslib_1.__exportStar(require("./lib/methods"), exports);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,wDAA8B;AAC9B,6DAAmC;AACnC,2DAAiC;AACjC,sDAA4B;AAC5B,wDAA8B;AAC9B,+DAAqC;AACrC,0DAAgC;AAChC,wDAA8B;AAC9B,2DAAiC;AACjC,wDAA8B;AAC9B,uDAA6B;AAC7B,wDAA8B;AAC9B,2DAAiC;AACjC,4DAAkC;AAClC,sDAA4B;AAC5B,0DAAgC;AAChC,mDAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,uDAA6B;AAC7B,wDAA8B;AAC9B,6DAAmC;AACnC,2DAAiC;AACjC,sDAA4B;AAC5B,wDAA8B;AAC9B,+DAAqC;AACrC,0DAAgC;AAChC,wDAA8B;AAC9B,wDAA8B;AAC9B,2DAAiC;AACjC,wDAA8B;AAC9B,uDAA6B;AAC7B,wDAA8B;AAC9B,2DAAiC;AACjC,4DAAkC;AAClC,sDAA4B;AAC5B,0DAAgC;AAChC,mDAAyB"}

package/src/lib/arrays/index.d.ts

@@ -0,0 +1,5 @@
+import { ArrayLiteralExpression } from 'ts-morph';
+export declare function pushToArray(array: ArrayLiteralExpression, ...items: string[]): void;
+export declare function pushToArrayIfNotExists(array: ArrayLiteralExpression, ...items: string[]): void;
+export declare function arrayIncludes(array: ArrayLiteralExpression, item: string): boolean;
+export declare function removeFromArray(array: ArrayLiteralExpression, ...items: string[]): void;

package/src/lib/arrays/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeFromArray = exports.arrayIncludes = exports.pushToArrayIfNotExists = exports.pushToArray = void 0;
+function pushToArray(array, ...items) {
+    array.addElements(items);
+}
+exports.pushToArray = pushToArray;
+function pushToArrayIfNotExists(array, ...items) {
+    array.addElements(items.filter((item) => !arrayIncludes(array, item)));
+}
+exports.pushToArrayIfNotExists = pushToArrayIfNotExists;
+function arrayIncludes(array, item) {
+    return !!array.getElements().find((exp) => exp.getText() === item);
+}
+exports.arrayIncludes = arrayIncludes;
+function removeFromArray(array, ...items) {
+    for (const item of items) {
+        const index = array.getElements().findIndex((exp) => exp.getText() === item);
+        if (index !== -1) {
+            array.removeElement(index);
+        }
+    }
+}
+exports.removeFromArray = removeFromArray;
+//# sourceMappingURL=index.js.map

package/src/lib/arrays/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/arrays/index.ts"],"names":[],"mappings":";;;AAEA,SAAgB,WAAW,CAAC,KAA6B,EAAE,GAAG,KAAe;IAC3E,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AAC3B,CAAC;AAFD,kCAEC;AAED,SAAgB,sBAAsB,CAAC,KAA6B,EAAE,GAAG,KAAe;IACtF,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACzE,CAAC;AAFD,wDAEC;AAED,SAAgB,aAAa,CAAC,KAA6B,EAAE,IAAY;IACvE,OAAO,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,CAAC;AACrE,CAAC;AAFD,sCAEC;AAED,SAAgB,eAAe,CAAC,KAA6B,EAAE,GAAG,KAAe;IAC/E,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,CAAC;QAE7E,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC;AARD,0CAQC"}

package/src/lib/helpers/index.d.ts

@@ -0,0 +1 @@
+export * from './match';

package/src/lib/helpers/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./match"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/helpers/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB"}

package/src/lib/helpers/match.d.ts

@@ -0,0 +1,2 @@
+import { MinimatchOptions } from 'minimatch';
+export declare function match(list: string | readonly string[], patterns: string | readonly string[], options?: MinimatchOptions): string[];

package/src/lib/helpers/match.js

@@ -0,0 +1,41 @@
+"use strict";
+/*
+ * This file includes code from the library multimatch.
+ * License for the original code:
+ *
+ * MIT License
+ *
+ * Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * The code was sourced from: https://github.com/sindresorhus/multimatch/blob/main/index.js
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.match = void 0;
+const minimatch_1 = require("minimatch");
+function match(list, patterns, options) {
+    list = [list].flat();
+    patterns = [patterns].flat();
+    if (list.length === 0 || patterns.length === 0) {
+        return [];
+    }
+    let result = [];
+    for (const item of list) {
+        for (let pattern of patterns) {
+            let process = (res, matches) => res.concat(matches);
+            if (pattern[0] === '!') {
+                pattern = pattern.slice(1);
+                process = (res, matches) => res.filter((x) => !matches.includes(x));
+            }
+            result = process(result, minimatch_1.minimatch.match([item], pattern, options));
+        }
+    }
+    return result;
+}
+exports.match = match;
+//# sourceMappingURL=match.js.map

package/src/lib/helpers/match.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"match.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/helpers/match.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,yCAAwD;AAExD,SAAgB,KAAK,CACnB,IAAgC,EAChC,QAAoC,EACpC,OAA0B;IAE1B,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACrB,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAE7B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,MAAM,GAAa,EAAE,CAAC;IAC1B,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,KAAK,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,IAAI,OAAO,GAAG,CAAC,GAAa,EAAE,OAAiB,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAExE,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC3B,OAAO,GAAG,CAAC,GAAa,EAAE,OAAiB,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1F,CAAC;YAED,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,qBAAS,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA3BD,sBA2BC"}