quackage 1.0.26 → 1.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.quackage-templates.json +15 -3
- package/.vscode/launch.json +1 -0
- package/debug/Harness.js +5 -1
- package/debug/Platform.md +3 -0
- package/debug/documentation-definition.json +53 -0
- package/debug/model/MeadowModel-Extended.json +1603 -0
- package/debug/model/entity/animals/Author.md +625 -0
- package/debug/model/entity/animals/Cat.md +3 -0
- package/debug/model/entity/clinics/Book.md +3 -0
- package/debug/model/entity/clinics/Vet.md +1 -0
- package/debug/model/entity_abstractions/animals.md +3 -0
- package/package.json +10 -8
- package/source/Default-Documentation-Definition.json +38 -0
- package/source/Quackage-CLIProgram.js +3 -0
- package/source/commands/Quackage-Command-BuildDocumentation.js +102 -0
- package/source/commands/Quackage-Command-BuildTemplates.js +0 -1
- package/source/services/Quackage-Documentation-Compile.js +404 -0
- package/source/services/Quackage-Documentation-Deploy.js +37 -0
- package/source/services/Quackage-Documentation-Gather.js +157 -0
- package/templates/pictview/source/Pict-View-QUACKAGEPROJECTNAMECAP-QUACKAGESCOPE.js +63 -0
- package/templates/pictviewproject/source/Pict-View-QUACKAGEPROJECTNAMECAP.js +38 -14
- package/templates/pictviewproject/test/Pict-View-QUACKAGEPROJECTNAMECAP_tests.js +2 -2
- package/templates/pictviewunittest/test/Pict_QUACKAGEPROJECTNAMECAP_QUACKAGESCOPE_test.js +2 -2
package/.quackage-templates.json
CHANGED
|
@@ -34,12 +34,12 @@
|
|
|
34
34
|
{
|
|
35
35
|
"Hash": "sourcePictViewQUACKAGEPROJECTNAMECAPjs",
|
|
36
36
|
"Path": "source/Pict-View-QUACKAGEPROJECTNAMECAP.js",
|
|
37
|
-
"Content": "const libPictView = require('pict-view');\n\nclass {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}
|
|
37
|
+
"Content": "const libPictView = require('pict-view');\n\nclass {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~} extends libPictView\n{\n\tconstructor(pFable, pOptions, pServiceHash)\n\t{\n\t\tsuper(pFable, pOptions, pServiceHash);\n\t}\n}\n\nmodule.exports = {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~};\n\n\n/**************************************\n * Default View Configuration *\n **************************************/\nmodule.exports.default_configuration =\n{\n\tViewIdentifier: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}',\n\n\tDefaultRenderable: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}',\n\tDefaultDestinationAddress: '#{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}_Container',\n\tDefaultTemplateRecordAddress: false,\n\n\t// If this is set to true, when the App initializes this will.\n\t// While the App initializes, initialize will be called.\n\tAutoInitialize: true,\n\tAutoInitializeOrdinal: 0,\n\n\t// If this is set to true, when the App autorenders (on load) this will.\n\t// After the App initializes, render will be called.\n\tAutoRender: true,\n\tAutoRenderOrdinal: 0,\n\n\tAutoSolveWithApp: true,\n\tAutoSolveOrdinal: 0,\n\n\tCSS: false,\n\tCSSPriority: 500,\n\n\tTemplates:\n\t[\n\t\t{\n\t\t\tHash: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-Template',\n\t\t\tTemplate: /*html*/`\n<!-- {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~} pict view template: [{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-Template] -->\n<!-- {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~} end view template: [{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-Template] -->\n`,\n\t\t},\n\t],\n\n\tRenderables:\n\t[\n\t\t{\n\t\t\tRenderableHash: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}',\n\t\t\tTemplateHash: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-Template',\n\t\t\tDestinationAddress: '#{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}_Container',\n\t\t\tRenderMethod: 'replace'\n\t\t},\n\t],\n\n\tManifests: {}\n};\n"
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
40
|
"Hash": "testPictViewQUACKAGEPROJECTNAMECAPtestsjs",
|
|
41
41
|
"Path": "test/Pict-View-QUACKAGEPROJECTNAMECAP_tests.js",
|
|
42
|
-
"Content": "/*\n\tUnit tests for {~Data:Record.Scope~} in {~Data:Record.Quackage.AppData.Package.name~} from Quackage Boilerplate\n*/\n\n// This is used to grab the source file from the package.json\nconst _Package = require(`../package.json`);\n// Get the \"main\" view from the package.json\n// If you want to test a specific subview, you can delete the above line and change the require below to the specific file.\nconst libPictView = require(`../${_Package.main}`);\n\n// Mocha, chai and the Expect verb\nconst Chai = require(\"chai\");\nconst Expect = Chai.expect;\n\n// This extends node to have the browser environment globals like window and document.\
|
|
42
|
+
"Content": "/*\n\tUnit tests for {~Data:Record.Scope~} in {~Data:Record.Quackage.AppData.Package.name~} from Quackage Boilerplate\n*/\n\n// This is used to grab the source file from the package.json\nconst _Package = require(`../package.json`);\n// Get the \"main\" view from the package.json\n// If you want to test a specific subview, you can delete the above line and change the require below to the specific file.\nconst libPictView = require(`../${_Package.main}`);\n\n// Mocha, chai and the Expect verb\nconst Chai = require(\"chai\");\nconst Expect = Chai.expect;\n\n// This extends node to have the browser environment globals like window and document.\n//const libBrowserEnv = require('browser-env')\n//libBrowserEnv();\n\nconst libPict = require('pict');\n\nconst _MockPictConfiguration = (\n{\n\tProduct: 'MockPict-ViewTest',\n\tProductVersion: _Package.version\n});\n\n// Any view-specific configuration goes here.\n// If there is no default_configuration object exported with your view, use an empty JSON object\nconst _MockPictViewConfiguration = (typeof(libPictView.default_configuration) === 'undefined') ? {} : libPictView.default_configuration;\n\nsuite\n(\n\t'{~Data:Record.Quackage.AppData.Package.name~} Pict View Suite',\n\tfunction()\n\t{\n\t\tsetup\n\t\t(\n\t\t\tfunction()\n\t\t\t{\n\t\t\t}\n\t\t);\n\n\t\tsuite\n\t\t(\n\t\t\t'Low Level',\n\t\t\tfunction()\n\t\t\t{\n\t\t\t\ttest\n\t\t\t\t(\n\t\t\t\t\t'View Construction',\n\t\t\t\t\tfunction(fDone)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar testPict = new libPict(_MockPictConfiguration);\n\t\t\t\t\t\tlet testView = testPict.addView('TestView', _MockPictViewConfiguration, libPictView);\n\t\t\t\t\t\tExpect(testView).to.be.an('object');\n\t\t\t\t\t\tExpect(testPict.views.TestView).to.be.an('object');\n\t\t\t\t\t\tExpect(testView.UUID).to.equal(testPict.views.TestView.UUID);\n\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t\ttest\n\t\t\t\t(\n\t\t\t\t\t'View Initialization',\n\t\t\t\t\tfunction(fDone)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar testPict = new libPict(_MockPictConfiguration);\n\t\t\t\t\t\tlet testView = testPict.addView('TestView', _MockPictViewConfiguration, libPictView);\n\t\t\t\t\t\ttestView.initialize();\n\t\t\t\t\t\tExpect(testView).to.be.an('object');\n\t\t\t\t\t\tExpect(testPict.views.TestView).to.be.an('object');\n\t\t\t\t\t\tExpect(testView.UUID).to.equal(testPict.views.TestView.UUID);\n\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t\ttest\n\t\t\t\t(\n\t\t\t\t\t'View Initialization (async)',\n\t\t\t\t\tfunction(fDone)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar testPict = new libPict(_MockPictConfiguration);\n\t\t\t\t\t\tlet testView = testPict.addView('TestView', _MockPictViewConfiguration, libPictView);\n\t\t\t\t\t\ttestView.initializeAsync(\n\t\t\t\t\t\t\t(fCallback) =>\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tExpect(testView).to.be.an('object');\n\t\t\t\t\t\t\t\tExpect(testPict.views.TestView).to.be.an('object');\n\t\t\t\t\t\t\t\tExpect(testView.UUID).to.equal(testPict.views.TestView.UUID);\n\t\t\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t\t\t});\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t}\n\t\t);\n\t}\n);"
|
|
43
43
|
}
|
|
44
44
|
]
|
|
45
45
|
},
|
|
@@ -129,7 +129,19 @@
|
|
|
129
129
|
{
|
|
130
130
|
"Hash": "testPictQUACKAGEPROJECTNAMECAPQUACKAGESCOPEtestjs",
|
|
131
131
|
"Path": "test/Pict_QUACKAGEPROJECTNAMECAP_QUACKAGESCOPE_test.js",
|
|
132
|
-
"Content": "/*\n\tUnit tests for {~Data:Record.Scope~} in {~Data:Record.Quackage.AppData.Package.name~} from Quackage Boilerplate\n*/\n\n// This is used to grab the source file from the package.json\nconst _Package = require(`../package.json`);\n// Get the \"main\" view from the package.json\n// If you want to test a specific subview, you can delete the above line and change the require below to the specific file.\nconst libPictView = require(`../${_Package.main}`);\n\n// Mocha, chai and the Expect verb\nconst Chai = require(\"chai\");\nconst Expect = Chai.expect;\n\n// This extends node to have the browser environment globals like window and document.\
|
|
132
|
+
"Content": "/*\n\tUnit tests for {~Data:Record.Scope~} in {~Data:Record.Quackage.AppData.Package.name~} from Quackage Boilerplate\n*/\n\n// This is used to grab the source file from the package.json\nconst _Package = require(`../package.json`);\n// Get the \"main\" view from the package.json\n// If you want to test a specific subview, you can delete the above line and change the require below to the specific file.\nconst libPictView = require(`../${_Package.main}`);\n\n// Mocha, chai and the Expect verb\nconst Chai = require(\"chai\");\nconst Expect = Chai.expect;\n\n// This extends node to have the browser environment globals like window and document.\n//const libBrowserEnv = require('browser-env')\n//libBrowserEnv();\n\nconst libPict = require('pict');\n\nconst _MockPictConfiguration = (\n{\n\tProduct: 'MockPict-ViewTest',\n\tProductVersion: _Package.version\n});\n\n// Any view-specific configuration goes here.\n// If there is no default_configuration object exported with your view, use an empty JSON object\nconst _MockPictViewConfiguration = (typeof(libPictView.default_configuration) === 'undefined') ? {} : libPictView.default_configuration;\n\nsuite\n(\n\t'{~Data:Record.Quackage.AppData.Package.name~} Pict View Suite',\n\tfunction()\n\t{\n\t\tsetup\n\t\t(\n\t\t\tfunction()\n\t\t\t{\n\t\t\t}\n\t\t);\n\n\t\tsuite\n\t\t(\n\t\t\t'Low Level',\n\t\t\tfunction()\n\t\t\t{\n\t\t\t\ttest\n\t\t\t\t(\n\t\t\t\t\t'View Construction',\n\t\t\t\t\tfunction(fDone)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar testPict = new libPict(_MockPictConfiguration);\n\t\t\t\t\t\tlet testView = testPict.addView('TestView', _MockPictViewConfiguration, libPictView);\n\t\t\t\t\t\tExpect(testView).to.be.an('object');\n\t\t\t\t\t\tExpect(testPict.views.TestView).to.be.an('object');\n\t\t\t\t\t\tExpect(testView.UUID).to.equal(testPict.views.TestView.UUID);\n\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t\ttest\n\t\t\t\t(\n\t\t\t\t\t'View Initialization',\n\t\t\t\t\tfunction(fDone)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar testPict = new libPict(_MockPictConfiguration);\n\t\t\t\t\t\tlet testView = testPict.addView('TestView', _MockPictViewConfiguration, libPictView);\n\t\t\t\t\t\ttestView.initialize();\n\t\t\t\t\t\tExpect(testView).to.be.an('object');\n\t\t\t\t\t\tExpect(testPict.views.TestView).to.be.an('object');\n\t\t\t\t\t\tExpect(testView.UUID).to.equal(testPict.views.TestView.UUID);\n\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t\ttest\n\t\t\t\t(\n\t\t\t\t\t'View Initialization (async)',\n\t\t\t\t\tfunction(fDone)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar testPict = new libPict(_MockPictConfiguration);\n\t\t\t\t\t\tlet testView = testPict.addView('TestView', _MockPictViewConfiguration, libPictView);\n\t\t\t\t\t\ttestView.initializeAsync(\n\t\t\t\t\t\t\t(fCallback) =>\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tExpect(testView).to.be.an('object');\n\t\t\t\t\t\t\t\tExpect(testPict.views.TestView).to.be.an('object');\n\t\t\t\t\t\t\t\tExpect(testView.UUID).to.equal(testPict.views.TestView.UUID);\n\t\t\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t\t\t});\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t}\n\t\t);\n\t}\n);"
|
|
133
|
+
}
|
|
134
|
+
]
|
|
135
|
+
},
|
|
136
|
+
"pictview": {
|
|
137
|
+
"Hash": "pictview",
|
|
138
|
+
"Name": "Pictview",
|
|
139
|
+
"Description": "A template set for pictview ...",
|
|
140
|
+
"Files": [
|
|
141
|
+
{
|
|
142
|
+
"Hash": "sourcePictViewQUACKAGEPROJECTNAMECAPQUACKAGESCOPEjs",
|
|
143
|
+
"Path": "source/Pict-View-QUACKAGEPROJECTNAMECAP-QUACKAGESCOPE.js",
|
|
144
|
+
"Content": "const libPictView = require('pict-view');\n\nclass {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}{~PascalCaseIdentifier:Record.Scope~} extends libPictView\n{\n\tconstructor(pFable, pOptions, pServiceHash)\n\t{\n\t\tsuper(pFable, pOptions, pServiceHash);\n\t}\n}\n\nmodule.exports = {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}{~PascalCaseIdentifier:Record.Scope~};\n\n\n/**************************************\n * Default View Configuration *\n **************************************/\nmodule.exports.default_configuration =\n{\n\tViewIdentifier: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}{~PascalCaseIdentifier:Record.Scope~}',\n\n\tDefaultRenderable: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-{~PascalCaseIdentifier:Record.Scope~}',\n\tDefaultDestinationAddress: '#{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}_{~PascalCaseIdentifier:Record.Scope~}_Container',\n\tDefaultTemplateRecordAddress: false,\n\n\t// If this is set to true, when the App initializes this will.\n\t// While the App initializes, initialize will be called.\n\tAutoInitialize: true,\n\tAutoInitializeOrdinal: 0,\n\n\t// If this is set to true, when the App autorenders (on load) this will.\n\t// After the App initializes, render will be called.\n\tAutoRender: true,\n\tAutoRenderOrdinal: 0,\n\n\tAutoSolveWithApp: true,\n\tAutoSolveOrdinal: 0,\n\n\tCSS: false,\n\tCSSPriority: 500,\n\n\tTemplates:\n\t[\n\t\t{\n\t\t\tHash: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-{~PascalCaseIdentifier:Record.Scope~}-Template',\n\t\t\tTemplate: /*html*/`\n<!-- {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~} pict view template: [{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-{~PascalCaseIdentifier:Record.Scope~}-Template] -->\n<!-- {~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~} end view template: [{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-{~PascalCaseIdentifier:Record.Scope~}-Template] -->\n`\n\t\t}\n\t],\n\n\tRenderables:\n\t[\n\t\t{\n\t\t\tRenderableHash: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-{~PascalCaseIdentifier:Record.Scope~}',\n\t\t\tTemplateHash: '{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}-{~PascalCaseIdentifier:Record.Scope~}-Template',\n\t\t\tDestinationAddress: '#{~PascalCaseIdentifier:Record.Quackage.AppData.Package.name~}_{~PascalCaseIdentifier:Record.Scope~}_Container',\n\t\t\tRenderMethod: 'replace'\n\t\t}\n\t],\n\n\tManifests: {}\n};\n"
|
|
133
145
|
}
|
|
134
146
|
]
|
|
135
147
|
}
|
package/.vscode/launch.json
CHANGED
package/debug/Harness.js
CHANGED
|
@@ -2,4 +2,8 @@ console.log('Fancy debug harness here. Shame if it would get quacked.');
|
|
|
2
2
|
|
|
3
3
|
let libQuackage = require('../source/Quackage-CLIProgram.js');
|
|
4
4
|
|
|
5
|
-
libQuackage.run(['node', 'Harness.js', '
|
|
5
|
+
//libQuackage.run(['node', 'Harness.js', 'bp', 'pictunittest']);
|
|
6
|
+
libQuackage.run(['node', 'Harness.js', 'lint']);
|
|
7
|
+
|
|
8
|
+
//libQuackage.run(['node', 'Harness.js', 'db', 'dist/documentation', '--meadow', 'model/MeadowModel-Extended.json']);
|
|
9
|
+
//libQuackage.run(['node', 'Harness.js', 'db', 'dist/documentation', '--meadow', 'model/MeadowModel-Extended.json', '-d', 'documentation-definition.json']);
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
{
|
|
2
|
+
"Title": "ACME Documentation",
|
|
3
|
+
|
|
4
|
+
"Parts": [
|
|
5
|
+
{
|
|
6
|
+
"Title": "Introduction",
|
|
7
|
+
"GeneratedContentFormatter": "BasicContent",
|
|
8
|
+
"SourceContentType": "RawMarkdown",
|
|
9
|
+
"RawMarkdownContent": "# The Introduction\n\n## Things are new?\n\nIt is a multi-line string, markdown. \n\n### Three are new?\n\nanything goes."
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
"Title": "Abstract Entities",
|
|
13
|
+
"GeneratedContentFormatter": "MeadowAbstractEntities",
|
|
14
|
+
"SourceContentType": "MeadowSchema",
|
|
15
|
+
"Filters": [
|
|
16
|
+
{
|
|
17
|
+
"ForwardLabelMatch": ["model", "entity"]
|
|
18
|
+
}]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"Title": "Tables",
|
|
22
|
+
"GeneratedContentFormatter": "MeadowTableGroups",
|
|
23
|
+
"SourceContentType": "MeadowSchema",
|
|
24
|
+
"Filters": [
|
|
25
|
+
{
|
|
26
|
+
"ForwardLabelMatch": ["model", "entity"]
|
|
27
|
+
}]
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"Title": "Example Queries",
|
|
31
|
+
"GeneratedContentFormatter": "BasicContent",
|
|
32
|
+
"SourceContentType": "MarkdownContent",
|
|
33
|
+
"Filters": [
|
|
34
|
+
{
|
|
35
|
+
"ForwardLabelMatch": ["model", "example_queries"]
|
|
36
|
+
}]
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"Title": "All Model Documentation",
|
|
40
|
+
"GeneratedContentFormatter": "BasicContent",
|
|
41
|
+
"SourceContentType": "MarkdownContent",
|
|
42
|
+
"Filters": [
|
|
43
|
+
{
|
|
44
|
+
"ForwardLabelMatch": ["model"]
|
|
45
|
+
}]
|
|
46
|
+
}],
|
|
47
|
+
"MeadowEntityCategories":
|
|
48
|
+
{
|
|
49
|
+
"Book": { "Group": "Paper"},
|
|
50
|
+
"BookAuthorJoin": { "Group": "Paper"},
|
|
51
|
+
"Author": { "Group": "People"}
|
|
52
|
+
}
|
|
53
|
+
}
|