Skip to content

Latest commit

 

History

History
47 lines (42 loc) · 4.01 KB

install.md

File metadata and controls

47 lines (42 loc) · 4.01 KB

Files

ProtoSS base is loaded and initiated using "new ZetaRet_Prototypes()". There are several bases you might choose to use:
protoss.all.js - All ProtoSS functionality, no minimization applied, instance is generated immediately, recommended use
protoss.js - Standard ProtoSS functionality, no minimization applied, no instance
min/protoss.all.min.js - All ProtoSS functionality, minimization applied, instance is generated immediately
min/protoss.min.js - Standard ProtoSS functionality, minimization applied, no instance, smallest

Additional Files

protoss.book.of.cheese.js must be preloaded before any other ProtoSS code, it adds polyfill implementation on base prototype primitives, usually not supported on mobile devices or old browsers
protoss.node.cheese.js must be preloaded before any ProtoSS file in Node.js server
protoss.node.module.js simple ProtoSS module loading external JS files and setting scope
min/protoss.all.min.js.gz contains protoss.all.min.js
min/protoss.min.js.gz contains protoss.min.js
README.md ProtoSS home screen

Examples

examples/protoss_examples.js supports basic inheritance example cases
examples/protoss_examples2.js builds basic game model example
examples/protoss_examples3.js demonstrates interfaces, abstracts and finalization of classes
examples/protoss_examples4.js supports packaging and super name concept
examples/mass.resolve.ProtoSS.js builds mass resolve example based on protoss/ProtoSS.js manager
examples/transform.ProtoSS.XeltoSS.js transform ProtoSS Class to XeltoSS Class in ES6 standard
examples/inline.morph.XeltoSS.js design template of protected scope using printed XeltoSS classes
examples/inline.morph.XeltoSS.intersect.js design template of protected scope using printed XeltoSS classes and protoss.all.js infrastructure
examples/inline.morph.XeltoSS.access.attributes.js design template of protected/private/internal/namespace scope using printed XeltoSS classes, protoss.all.js infrastructure and CRUD-compliant AccessAttribute class prototype
examples/node_example.js ProtoSS module example using require and consoles ProtoSS Objects

Documentation

protoss.all.js uses dox/protoss.all.md
protoss.js uses dox/protoss.md
min/protoss.all.min.js uses dox/protoss.all.md
min/protoss.min.js uses dox/protoss.md
dox/hints.txt exposes end case scenarios in OOP js concept
dox/packager_guide.txt naming concept in packaging namespaces
dox/jsondox_template.json structured template for PHP bundler and Atom IDE using ide-protoss
dox/protossdox.json structured project template for Atom IDE using ide-protoss
eclipse_templates/eclipse_protoss_templates.xml can be imported in Eclipse suggestion templates, uses "protoss" keyword in JavaScript context
atom_snippets/snippets.cson can be imported in Atom IDE Snippets (access from File->Snippets and copy-paste), uses "protoss" keyword in JavaScript context
vscode_snippets/javascript.json can be imported in Visual Studio Code User Snippets (access from File->Preferences->User Snippets and copy-paste), uses "protoss" keyword in JavaScript context

Extensions

ProtoSS.js can be found in protoss/ProtoSS.js including documentation, header and interface
XeltoSS.js can be found in xeltoss/XeltoSS.js including documentation, header and interface
SkytoSS.js can be found in skytoss/SkytoSS.js including documentation, header and interface

Headers & Load Order

Classes are loaded always before Headers in HTML. Each Header requires a hard reference to ProtoSS Class definition, all other references inside the Header Array, present or super class(es), can be soft string literals resolved later. Backend may pack JS code in either way of <script src="file.js"> method or output it directly into the script tag.