babylonjs-post-process 8.56.2 → 9.1.0

package/readme.md

@@ -1,53 +1,42 @@
-Babylon.js Post Processes Library
-=====================
+# Babylon.js Post Processes Library
 
-For usage documentation please visit https://doc.babylonjs.com/extensions and choose "post process library".
+> We recommend using the [ES6 package `@babylonjs/post-processes`](https://www.npmjs.com/package/@babylonjs/post-processes) for new projects.
 
-# Installation instructions
+For usage documentation please visit the [post process library documentation](https://doc.babylonjs.com/toolsAndResources/assetLibraries/postProcessLibrary/).
 
-## CDN
+## Installation
+
+### CDN
 
 > ⚠️ WARNING: The CDN should not be used in production environments. The purpose of our CDN is to serve Babylon packages to users learning how to use the platform or running small experiments. Once you've built an application and are ready to share it with the world at large, you should serve all packages from your own CDN.
 
 Compiled js files (minified and source) are offered on our public CDN here:
 
-* https://preview.babylonjs.com/postProcessesLibrary/babylonjs.postProcess.js
-* https://preview.babylonjs.com/postProcessesLibrary/babylonjs.postProcess.min.js
+- https://preview.babylonjs.com/postProcessesLibrary/babylonjs.postProcess.js
+- https://preview.babylonjs.com/postProcessesLibrary/babylonjs.postProcess.min.js
 
-## NPM
+### NPM
 
-To install using npm :
+To install using npm:
 
-```
-npm install --save babylonjs babylonjs-post-process
+```bash
+npm install babylonjs babylonjs-post-process
 ```
 
 If using TypeScript, the typing needs to be added to tsconfig.json:
 
-```
-    ....
+```json
     "types": [
         "babylonjs",
-        "babylonjs-post-process",
-        "oneMoreDependencyThatIReallyNeed"
-    ],
-    ....
+        "babylonjs-post-process"
+    ]
 ```
 
 Afterwards it can be imported to the project using:
 
-```
-import * as BABYLON from 'babylonjs';
-import 'babylonjs-post-process';
-```
-
-This will extend Babylon's namespace with the post processes available:
+```javascript
+import * as BABYLON from "babylonjs";
+import "babylonjs-post-process";
 
+const postProcess = new BABYLON.AsciiArtPostProcess("AsciiArt", camera);
 ```
-// Some awesome code
-// Creates the post process
-let postProcess = new BABYLON.AsciiArtPostProcess("AsciiArt", camera);
-// Some more awesome code
-```
-
-Using webpack to package your project will use the minified js file.

package/src/asciiArt.ts

@@ -1,3 +1,3 @@
-import * as postProcess from "@lts/post-processes/legacy/legacy-asciiArt";
+import * as postProcess from "post-processes/legacy/legacy-asciiArt";
 export { postProcess };
 export default postProcess;

package/src/digitalRain.ts

@@ -1,3 +1,3 @@
-import * as postProcess from "@lts/post-processes/legacy/legacy-digitalRain";
+import * as postProcess from "post-processes/legacy/legacy-digitalRain";
 export { postProcess };
 export default postProcess;

package/src/index.ts

@@ -1,3 +1,3 @@
-import * as postProcess from "@lts/post-processes/legacy/legacy";
+import * as postProcess from "post-processes/legacy/legacy";
 export { postProcess };
 export default postProcess;

package/tsconfig.build.json

@@ -5,12 +5,13 @@
         "outDir": "./dist",
         "rootDir": "../../../",
         "target": "ES5",
+        "ignoreDeprecations": "6.0",
         "declaration": false,
         "importHelpers": true,
         "paths": {
-            "core/*": ["dev/core/dist/*"],
-            "post-processes/*": ["dev/postProcesses/src/*"],
-            "@lts/post-processes/*": ["lts/postProcesses/src/*"]
+            "core/*": ["../../../dev/core/dist/*"],
+            "post-processes/*": ["../../../dev/postProcesses/src/*"],
+            "@lts/post-processes/*": ["../../../lts/postProcesses/src/*"]
         }
     },
     "include": ["./src/**/*", "../../../dev/postProcesses/src/**/*", "../../../lts/postProcesses/src/**/*"]

package/tsconfig.json

@@ -3,8 +3,8 @@
 
     "compilerOptions": {
         "paths": {
-            "post-processes/*": ["dev/postProcesses/src/*"],
-            "@lts/post-processes/*": ["lts/postProcesses/src/*"],
+            "post-processes/*": ["../../../dev/postProcesses/src/*"],
+            "@lts/post-processes/*": ["../../../lts/postProcesses/src/*"],
         }
     },
 }

package/webpack.config.js

@@ -1,24 +1,23 @@
-const commonConfigGenerator = require("@dev/build-tools").webpackTools.commonUMDWebpackConfiguration;
-const path = require("path");
-module.exports = (env) => {
-    const commonConfig = commonConfigGenerator({
-        mode: env.production ? "production" : "development",
-        devPackageName: "post-processes",
-        namespace: "POSTPROCESSES",
-        outputPath: path.resolve(__dirname),
-        entryPoints: {
-            postProcess: "./src/index.ts",
-            asciiArt: "./src/asciiArt.ts",
-            digitalRain: "./src/digitalRain.ts",
-        },
-        alias: {
-            "post-processes": path.resolve(__dirname, "../../../dev/postProcesses/src"),
-            "@lts/post-processes": path.resolve(__dirname, "../../../lts/postProcesses/src"),
-        },
-        overrideFilename: (pathData) => {
-            return pathData.chunk.name === "postProcess" ? `babylonjs.[name]${env.production ? ".min" : ""}.js` : `babylon.[name]PostProcess${env.production ? ".min" : ""}.js`;
-        },
-        minToMax: true,
-    });
-    return commonConfig;
-};
+const commonConfigGenerator = require("@dev/build-tools").webpackTools.commonUMDWebpackConfiguration;
+const path = require("path");
+module.exports = (env) => {
+    const commonConfig = commonConfigGenerator({
+        mode: env.production ? "production" : "development",
+        devPackageName: "post-processes",
+        namespace: "POSTPROCESSES",
+        outputPath: path.resolve(__dirname),
+        entryPoints: {
+            postProcess: "./src/index.ts",
+            asciiArt: "./src/asciiArt.ts",
+            digitalRain: "./src/digitalRain.ts",
+        },
+        alias: {
+            "post-processes": path.resolve(__dirname, "../../../dev/postProcesses/src"),
+        },
+        overrideFilename: (pathData) => {
+            return pathData.chunk.name === "postProcess" ? `babylonjs.[name]${env.production ? ".min" : ""}.js` : `babylon.[name]PostProcess${env.production ? ".min" : ""}.js`;
+        },
+        minToMax: true,
+    });
+    return commonConfig;
+};