dazscript-framework 0.1.9 → 0.1.10

package/README.md

@@ -1 +1,93 @@
 # DazScript Framework
+
+The **DazScript Framework** is a TypeScript-based framework for writing Daz Studio scripts. It provides all the advantages of a typed language such as autocompletion, error checking, and method parameter documentation and hinting. The framework also includes a set of dialog helpers for rapid UI development.
+
+## Benefits
+
+- **Autocompletion:** Take advantage of IDE autocompletion for faster and more efficient script development.
+- **Error Checking:** Catch potential errors early in the development process with TypeScript's static analysis.
+- **Method Documentation & Hinting:** Get contextual documentation and hints for methods, classes, and parameters.
+
+## Features
+
+- TypeScript support with full IntelliSense.
+- A powerful set of decorators and helper methods for building interactive scripts.
+- Easy integration with Daz Studio for quick script deployment.
+
+## Installation
+
+To install the **DazScript Framework**, run the following command:
+
+```bash
+npm install dazscript-framework
+```
+
+## Setup
+
+After installing the package, you will need to configure a few files for your project.
+
+1. **babel.config.js**
+
+   Create the file and add the following content:
+
+   ```javascript
+   const sharedBabelConfig = require('dazscript-framework/babel');
+
+   module.exports = {
+     ...sharedBabelConfig,
+     presets: [...sharedBabelConfig.presets],
+     plugins: [...sharedBabelConfig.plugins],
+   };
+   ```
+
+2. **package.json**
+
+   Add the following scripts to your package.json:
+
+   ```json
+   "scripts": {
+       "prebuild": "npm run installer",
+       "build": "webpack --env outputPath=./out",
+       "postbuild": "npm run icons",
+       "watch": "webpack --env outputPath=./out --watch",
+       "icons": "copyfiles -u 1 src/**/*.png out/",
+       "installer": "node ./node_modules/dazscript-framework/dist/scripts/install-generator.js -p ./src/scripts -m /My Scripts"
+   }
+   ```
+
+3. **tsconfig.json**
+
+   Create the file and add the following content:
+
+   ```json
+   {
+     "extends": "./node_modules/dazscript-framework/tsconfig.json",
+     "compilerOptions": {
+       "baseUrl": "./",
+       "paths": {
+         "shared/*": ["src/shared/*"],
+         "@dst/*": ["node_modules/dazscript-types/*"],
+         "@dsf/*": ["node_modules/dazscript-framework/src/*"]
+       }
+     },
+     "include": ["node_modules/dazscript-types/**/*", "src/**/*"]
+   }
+   ```
+
+4. **webpack.config.js**
+   Create the file and add the following content:
+
+   ```javascript
+   const sharedWebpackConfig = require('dazscript-framework/webpack');
+
+   module.exports = (env, argv) => {
+     const sharedConfig = sharedWebpackConfig(env, argv);
+
+     return {
+       ...sharedConfig,
+       // You can override or add more customizations here if needed
+     };
+   };
+   ```
+
+## Usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dazscript-framework",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "author": "Freddy Diaz",
   "license": "MPL-2.0",
   "description": "",
@@ -28,7 +28,7 @@
   },
   "files": [
     "tsconfig.json",
-    "webpack.config",
+    "webpack.config.js",
     "babel.config.js",
     "dist/**/*",
     "src/**/*"

package/webpack.config.js

@@ -0,0 +1,70 @@
+const path = require('path');
+const glob = require('glob');
+const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin');
+
+module.exports = (env, argv) => {
+  const isFileSpecified = env && env.file;
+  const entryFiles = isFileSpecified
+    ? [`./src/${env.file}.dsa.ts`]
+    : glob.sync('./src/**/*.dsa.ts');
+
+  const outputPath =
+    env && env.outputPath
+      ? path.resolve(env.outputPath)
+      : path.resolve(__dirname, 'out');
+
+  return {
+    mode: 'production',
+    optimization: {
+      usedExports: true,
+    },
+    entry: entryFiles.reduce((acc, filePath) => {
+      const entry = filePath.replace('.dsa.ts', '').replace('src/', '');
+      acc[entry] = `./${filePath}`;
+      return acc;
+    }, {}),
+    module: {
+      rules: [
+        {
+          test: /\.ts$/,
+          use: [
+            {
+              loader: 'babel-loader',
+            },
+            {
+              loader: 'ts-loader',
+              options: {
+                allowTsInNodeModules: true,
+              },
+            },
+          ],
+          exclude: [
+            {
+              and: [path.resolve(__dirname, 'node_modules')],
+              not: [
+                path.resolve(__dirname, 'node_modules/dazscript-framework/src'),
+              ],
+            },
+          ],
+        },
+      ],
+    },
+    resolve: {
+      extensions: ['.ts'],
+      plugins: [new TsconfigPathsPlugin()],
+    },
+    output: {
+      filename: '[name].dsa',
+      path: outputPath,
+      environment: {
+        arrowFunction: false,
+        bigIntLiteral: false,
+        const: false,
+        destructuring: false,
+        dynamicImport: false,
+        forOf: true,
+        module: false,
+      },
+    },
+  };
+};