arcs / arcs.js

Go to a project
Toggle navigation Toggle navigation pinning
Jean-Yves Didier
32d82bed 1 parent e54a145f

added linter as well as cleaner documentation generation

Inline Side-by-side
Showing 10 changed files with 65 additions and 94 deletions
...@@ -5,55 +5,6 @@ module.exports = function (grunt) { ...@@ -5,55 +5,6 @@ module.exports = function (grunt) {
5 5
6 // Project configuration. 6 // Project configuration.
7 grunt.initConfig({ 7 grunt.initConfig({
8 - pkg: grunt.file.readJSON('package.json'),
9 - copy: {
10 - dist: {
11 - files:[
12 - {src: 'src/arcs_browser.js', dest: 'build/arcs_browser.js'},
13 - {src: 'src/arcs_node.mjs', dest: 'build/arcs_node.mjs'}
14 - ]
15 -
16 - }
17 - },
18 - jsdoc: {
19 - dist: {
20 - src: ['src/*.js', 'docs/Readme.md'], //, 'components/*.js'],
21 - options: {
22 - /*verbose: true,
23 - access: 'all',
24 - private: true,*/
25 - destination: 'docs/engine',
26 - template: 'docs/arcs',
27 - configure: 'docs/jsdoc.conf.json'
28 -
29 - }
30 - },
31 - components : {
32 - src: ['components/*.js', 'deps/surf/surf.js', 'deps/pose/posit_gen.js'],
33 - options: {
34 - verbose: true,
35 - destination: 'docs/components',
36 - template: 'docs/arcs',
37 - configure: 'docs/jsdoc.conf.json'
38 - }
39 - }
40 - },
41 - jslint: {
42 - dist: {
43 - src: ['*.js'],
44 - exclude: ['require.js', 'text.js'],
45 - directives: {
46 - node: true,
47 - sloppy: true,
48 - plusplus: true,
49 - forin: true,
50 - devel: true,
51 - white: true,
52 - predef: ['define', 'arcs_module', 'document']
53 - //browser: true,
54 - }
55 - }
56 - },
57 terser: { 8 terser: {
58 build: { 9 build: {
59 files: { 10 files: {
...@@ -114,23 +65,6 @@ module.exports = function (grunt) { ...@@ -114,23 +65,6 @@ module.exports = function (grunt) {
114 } 65 }
115 }, 66 },
116 concat: { 67 concat: {
117 - dist: {
118 - src: [
119 - 'src/arcs.js', *
120 - 'src/component.js', *
121 - 'src/context.js', *
122 - 'src/invocation.js', *
123 - 'src/connection.js', *
124 - 'src/sheet.js',
125 - 'src/eventlogicparser.js', *
126 - 'src/tokenevent.js', *
127 - 'src/transitionnetwork.js', *
128 - 'src/statemachine.js', *
129 - 'src/application.js',
130 - 'src/exports.js' *
131 - ],
132 - dest: 'build/arcs.js'
133 - },
134 editor : { 68 editor : {
135 src: [ 69 src: [
136 'utils/editor/arcseditor.js', 70 'utils/editor/arcseditor.js',
......
...@@ -1260,7 +1260,7 @@ let Context = function( ctx ) { ...@@ -1260,7 +1260,7 @@ let Context = function( ctx ) {
1260 1260
1261 } 1261 }
1262 1262
1263 - var loadDataFile =async function(fileName) { 1263 + var loadDataFile = async function(fileName) {
1264 var dataPromise ; 1264 var dataPromise ;
1265 1265
1266 if ((0,_arcs_js__WEBPACK_IMPORTED_MODULE_1__.default)()) { 1266 if ((0,_arcs_js__WEBPACK_IMPORTED_MODULE_1__.default)()) {
......
...@@ -308,10 +308,6 @@ ARViewer = ARCS.Component.create( ...@@ -308,10 +308,6 @@ ARViewer = ARCS.Component.create(
308 } 308 }
309 309
310 }, 310 },
311 -<<<<<<< HEAD
312 - [ 'deps/three.js/index','deps/three.js/frustumcamera']
313 -);
314 -=======
315 /** @lends ARViewer.slots */ 311 /** @lends ARViewer.slots */
316 [ 312 [
317 'setWidgets','setFocal','viewAll','setSize','addScene', 313 'setWidgets','setFocal','viewAll','setSize','addScene',
...@@ -324,4 +320,3 @@ ARViewer = ARCS.Component.create( ...@@ -324,4 +320,3 @@ ARViewer = ARCS.Component.create(
324 320
325 export default {ARViewer: ARViewer}; 321 export default {ARViewer: ARViewer};
326 322
327 ->>>>>>> modules
......
1 +{
2 + "plugins": ["sigslot.js"],
3 + "source" : {
4 + "include" : [ "../components", "Readme.md", "../deps/surf/surf.js", "../deps/pose/posit_gen.js" ]
5 + },
6 + "opts" : {
7 + "template": "arcs",
8 + "destination": "components"
9 + }
10 +}
1 +{
2 + "plugins": ["sigslot.js"],
3 + "source" : {
4 + "include" : [ "../src", "Readme.md" ]
5 + },
6 + "opts" : {
7 + "template": "arcs",
8 + "destination": "engine"
9 + }
10 +}
1 -{
2 - "plugins": ["docs/sigslot.js"]
3 -}
1 { 1 {
2 "name": "ARCS", 2 "name": "ARCS",
3 - "version": "0.1.0", 3 + "version": "0.9.0",
4 "description": "Augmented Reality Component System in web browser and node environment", 4 "description": "Augmented Reality Component System in web browser and node environment",
5 "main": "build/arcs.js", 5 "main": "build/arcs.js",
6 "scripts": { 6 "scripts": {
...@@ -10,6 +10,18 @@ ...@@ -10,6 +10,18 @@
10 "Augmented", 10 "Augmented",
11 "Reality" 11 "Reality"
12 ], 12 ],
13 + "eslintConfig": {
14 + "env": {
15 + "browser": true,
16 + "es2021": true
17 + },
18 + "parserOptions": {
19 + "sourceType": "module"
20 + },
21 + "rules": {
22 + "func-style": "off"
23 + }
24 + },
13 "author": "Jean-Yves Didier", 25 "author": "Jean-Yves Didier",
14 "license": "GPL-3.0-or-later", 26 "license": "GPL-3.0-or-later",
15 "dependencies": { 27 "dependencies": {
...@@ -19,15 +31,8 @@ ...@@ -19,15 +31,8 @@
19 "codemirror": ">=5.62" 31 "codemirror": ">=5.62"
20 }, 32 },
21 "devDependencies": { 33 "devDependencies": {
22 - "bower": ">=1.3.9", 34 + "copy-webpack-plugin": "^9.0.1",
23 - "grunt": ">=0.4.5", 35 + "eslint-webpack-plugin": "^3.0.1",
24 - "grunt-jslint": ">=1.1.12", 36 + "jsdoc-webpack-plugin": "^0.3.0"
25 - "grunt-terser": "*",
26 - "grunt-jsdoc": ">=0.5.6",
27 - "grunt-bower-task": ">=0.4.0",
28 - "grunt-contrib-concat": ">=0.5.0",
29 - "grunt-contrib-copy": ">=1.0.0",
30 - "grunt-file-append": ">=0.0.7",
31 - "grunt-string-replace": ">=1.3.1"
32 } 37 }
33 } 38 }
......
...@@ -7,8 +7,8 @@ ...@@ -7,8 +7,8 @@
7 "use strict"; 7 "use strict";
8 8
9 // basically, here we start by importing the module ARCS 9 // basically, here we start by importing the module ARCS
10 -import ARCS from './exports.js'; 10 +//import ARCS from './exports.js';
11 - 11 +import ARCS from "./arcs.js";
12 12
13 console.log("[ARCS] Bootstrapping..."); 13 console.log("[ARCS] Bootstrapping...");
14 14
......
...@@ -43,7 +43,7 @@ let Context = function( ctx ) { ...@@ -43,7 +43,7 @@ let Context = function( ctx ) {
43 43
44 } 44 }
45 45
46 - var loadDataFile =async function(fileName) { 46 + var loadDataFile = async function(fileName) {
47 var dataPromise ; 47 var dataPromise ;
48 48
49 if (isInNode()) { 49 if (isInNode()) {
......
1 const path = require('path'); 1 const path = require('path');
2 +const jsdoc = require('jsdoc-webpack-plugin');
3 +const copy = require('copy-webpack-plugin');
4 +const eslint = require('eslint-webpack-plugin');
2 5
3 module.exports = { 6 module.exports = {
4 experiments : { 7 experiments : {
...@@ -8,10 +11,6 @@ module.exports = { ...@@ -8,10 +11,6 @@ module.exports = {
8 'arcs' : { 11 'arcs' : {
9 import : './src/exports.js', 12 import : './src/exports.js',
10 }, 13 },
11 - 'arcs_browser' : {
12 - import : './src/arcs_browser.js'
13 - //dependOn : ['arcs']
14 - }
15 }, 14 },
16 mode: 'none', 15 mode: 'none',
17 output: { 16 output: {
...@@ -27,5 +26,26 @@ module.exports = { ...@@ -27,5 +26,26 @@ module.exports = {
27 commonjsMagicComments: true 26 commonjsMagicComments: true
28 } 27 }
29 } 28 }
30 - } 29 + },
30 + plugins: [
31 + new jsdoc({
32 + conf: 'docs/engine.conf.json',
33 + destination: 'docs/engine',
34 + template: 'docs/arcs',
35 + }),
36 + new jsdoc({
37 + conf: 'docs/components.conf.json',
38 + destination: 'docs/components',
39 + template: 'docs/arcs',
40 + }),
41 + new copy({
42 + patterns: [
43 + { from : 'src/arcs_browser.js', to: 'arcs_browser.js'},
44 + { from: 'src/arcs_node.mjs', to: 'arcs_node.mjs'}
45 + // TODO put here also files for dep directory.
46 + // can also prepend content and replace strings using the transform property!
47 + ]
48 + }),
49 + new eslint({})
50 + ]
31 }; 51 };
......