Merge pull request #5 from jrod-disco/develop

DEVELOP v0.2.0 to MASTER

Author: jrod-disco

.eslintrc.js

@@ -1,14 +1,16 @@
 module.exports = {
-  parser: "@typescript-eslint/parser", // Specifies the ESLint parser
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
   extends: [
-    "plugin:@typescript-eslint/recommended", // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
   ],
   parserOptions: {
     ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
-    sourceType: "module", // Allows for the use of imports
+    sourceType: 'module', // Allows for the use of imports
   },
   rules: {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     // e.g. "@typescript-eslint/explicit-function-return-type": "off",
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': 'warn',
   },
 };

.gitignore

@@ -55,9 +55,6 @@ lib-cov
 coverage
 *.lcov
 
-# nyc test coverage
-.nyc_output
-
 # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
@@ -120,18 +117,6 @@ dist/
 .out
 .storybook-out
 
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
 # Temporary folders
 tmp/
 temp/
@@ -179,95 +164,9 @@ GitHub.sublime-settings
 # Ignore all local history of files
 .history
 
-### WebStorm ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
-
-# Generated files
-.idea/**/contentModel.xml
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-
-# Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# Gradle and Maven with auto-import
-# When using Gradle or Maven with auto-import, you should exclude module files,
-# since they will be recreated, and may cause churn.  Uncomment if using
-# auto-import.
-# .idea/modules.xml
-# .idea/*.iml
-# .idea/modules
-# *.iml
-# *.ipr
-
-# CMake
-cmake-build-*/
-
-# Mongo Explorer plugin
-.idea/**/mongoSettings.xml
-
-# File-based project format
-*.iws
-
-# IntelliJ
-out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
 
 # JIRA plugin
 atlassian-ide-plugin.xml
 
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-# Editor-based Rest Client
-.idea/httpRequests
-
-# Android studio 3.1+ serialized cache file
-.idea/caches/build_file_checksums.ser
-
-### WebStorm Patch ###
-# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
-
-# *.iml
-# modules.xml
-# .idea/misc.xml
-# *.ipr
-
-# Sonarlint plugin
-.idea/**/sonarlint/
-
-# SonarQube Plugin
-.idea/**/sonarIssues.xml
-
-# Markdown Navigator plugin
-.idea/**/markdown-navigator.xml
-.idea/**/markdown-navigator/
-
-# End of https://www.gitignore.io/api/node,macos,webstorm,sublimetext,visualstudiocode
-
-# Dist files
-dist/
+# Working Asset Folders
+working-assets/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jose R. Rodriguez, JRVisuals LLC
+
+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.

README.md

@@ -1,3 +1,55 @@
-# DCollage (Digital Collage Boilerplate)
+### Bootstrapped with DCollage (Digital Collage Boilerplate w/ PIXIJS)
 
-The goal of DCollage is to facilitate the creation of multi-layered, interactive, collages similar to those I created back in the days of Flash.
+The goal of DCollage is to facilitate the creation of multi-layered, interactive, collages similar to those I created back in the days of Flash. Surprise it works for simple games too!
+
+# Project Title
+
+Project description may appear here.
+
+## Concept and Mechanics
+
+TBD
+
+## Roadmap
+
+- [x] Bootstraping
+
+  - [x] create repo
+  - [x] clean-up remnants from past usage
+  - [x] get it running the game loop bare bones
+
+- [ ] TBD
+  - [ ] TBD
+
+### Completed!
+
+Nothing yet
+
+## Libraries Used
+
+- PIXIJS - WebGL renderer with Canvas fallback and so much more [https://github.com/pixijs/pixi.js](https://github.com/pixijs/pixi.js)
+- pixi-filters - Collection of community-authored custom display filters for PixiJS [https://github.com/pixijs/pixi-filters](https://github.com/pixijs/pixi-filters) Currently yarn linked to a local version of the repo in order to use the as of yet un-merged changes to the godray filter which add alpha functionality.
+- GSAP - tween animation library [https://greensock.com/docs/v2/Plugins/PixiPlugin](https://greensock.com/docs/v2/Plugins/PixiPlugin)
+
+## Tools Used
+
+- Visual Studio Code
+- Sublime Text
+- Aesprite
+- Audacity
+- Reason
+
+# Build Scripts
+
+- `yarn start` to go into development mode with live reload
+- `yarn clean` to clean the `/dist` directory
+- `yarn build` to create a distributable bundle in `/dist`
+- `yarn docs` to generate markdown documentation in `/docs`
+
+# The Stack
+
+- Pixi.JS
+- TypeScript
+- Prettier
+- Rollup
+- TSDoc / TypeDoc

markdownStyles.css

@@ -0,0 +1,49 @@
+body {
+  background: #303341;
+  color: #ffffff;
+}
+
+.vscode-dark a {
+  color: #61afef;
+}
+
+.vscode-dark h1,
+.vscode-dark h2,
+.vscode-dark h3,
+.vscode-dark h4,
+.vscode-dark h5,
+.vscode-dark h6 {
+  font-weight: 600;
+  color: #964653;
+}
+
+.vscode-dark,
+.vscode-dark pre code {
+  color: #abb2bf;
+}
+
+.vscode-dark code {
+  color: #90c378;
+}
+
+.vscode-dark pre:not(.hljs),
+.vscode-dark code > div {
+  background-color: #2c323c;
+}
+
+.vscode-dark table > thead > tr > th {
+  border-color: #2c323c;
+}
+
+.vscode-dark h1,
+.vscode-dark hr,
+.vscode-dark table > tbody > tr + tr > td {
+  border-color: #2c323c;
+}
+
+.vscode-dark blockquote {
+  color: #5c6370;
+  font-style: italic;
+  background: transparent;
+  border-color: #2c323c;
+}

package.json

@@ -1,22 +1,25 @@
 {
   "name": "dcollage",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A digital collage boilerplate.",
   "main": "main.js",
   "repository": "https://github.com/jrod-disco/dcollage",
   "author": "jrod-disco <[email protected]>",
   "license": "MIT",
   "private": false,
-  "dependencies": {},
   "devDependencies": {
-    "gsap": "^3.2.5",
-    "pixi-sound": "^3.0.4",
-    "pixi.js": "^5.1.6",
-    "@pixi/filter-glitch": "^3.1.1",
+    "@microsoft/tsdoc": "^0.12.19",
+    "@pixi/filter-shockwave": "^3.1.1",
+    "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^7.1.1",
-    "@typescript-eslint/eslint-plugin": "^2.24.0",
-    "@typescript-eslint/parser": "^2.24.0",
+    "@rollup/plugin-replace": "^2.3.3",
+    "@typescript-eslint/eslint-plugin": "2.34.0",
+    "@typescript-eslint/parser": "2.34.0",
     "eslint": "^6.8.0",
+    "gsap": "^3.2.5",
+    "pixi-particles": "^4.2.1",
+    "pixi-sound": "^3.0.4",
+    "pixi.js": "5.2.0",
     "prettier": "^2.0.1",
     "rimraf": "^3.0.2",
     "rollup": "^2.1.0",
@@ -26,13 +29,19 @@
     "rollup-plugin-livereload": "^1.1.0",
     "rollup-plugin-scss": "^2.1.0",
     "rollup-plugin-serve": "^1.0.1",
+    "rollup-plugin-terser": "^5.3.0",
     "rollup-plugin-typescript2": "^0.26.0",
     "sass": "^1.26.3",
-    "typescript": "^3.8.3"
+    "tslib": "^2.0.0",
+    "typedoc": "^0.17.6",
+    "typedoc-plugin-markdown": "^2.2.17",
+    "typescript": "3.9.7"
   },
+  "dependencies": {},
   "scripts": {
-    "start": "rollup -c -w",
+    "start": "rollup -c -w --environment BUILD:dev",
     "clean": "rimraf dist",
-    "build": "rollup -c"
+    "build": "rimraf dist && rollup -c --environment BUILD:prod",
+    "docs": "rimraf docs && npx typedoc --excludeExternals --entryPoint 'main' --stripInternal --readme none"
   }
 }

rollup.config.js

@@ -4,29 +4,44 @@ import serve from 'rollup-plugin-serve';
 import livereload from 'rollup-plugin-livereload';
 import typescript from 'rollup-plugin-typescript2';
 import commonjs from 'rollup-plugin-commonjs';
+import json from '@rollup/plugin-json';
 import resolve from '@rollup/plugin-node-resolve';
+import replace from '@rollup/plugin-replace';
 import copy from 'rollup-plugin-copy';
+import { terser } from 'rollup-plugin-terser';
+
+import pkg from './package.json';
+
+const isProd = process.env.BUILD === 'prod';
+const isDev = process.env.BUILD === 'dev';
 
 export default [
   {
-    input: './src/index.ts',
+    input: './src/main.ts',
     output: [
       {
         file: './dist/app.js',
         format: 'iife',
+        globals: {
+          'pixi.js': 'PIXI',
+        },
       },
     ],
 
     plugins: [
-      resolve({ browser: true, preferBuiltins: false }),
+      resolve({ base: 'src', browser: true, preferBuiltins: false }),
+      replace({
+        __VERSION__: JSON.stringify(pkg.version),
+      }),
       typescript({}),
       commonjs({
         namedExports: {
           'node_modules/pixi.js/lib/pixi.es.js': ['sound'],
         },
       }),
       scss(),
-      html({ template: './src/index.html' }),
+      html({ template: './src/index.html', inject: false }),
+      isProd && terser(),
       copy({
         targets: [
           {
@@ -35,8 +50,10 @@ export default [
           },
         ],
       }),
-      serve('dist/'),
-      livereload(),
+      isDev && serve('dist/'),
+      isDev && livereload(),
     ],
+    // Don't bundle PIXI -- coming via CDN in index.html
+    external: ['pixi.js'],
   },
 ];