crownpeak-dxm-vuejs-sdk - npm Package Compare versions

Comparing version 1.0.4 to 2.0.0

classes/crownpeak/cmsify.js

@@ -8,2 +8,7 @@ #!/usr/bin/env node
 const main = () => {
+    if (_args.findIndex(a => a.toLowerCase() === "--help") > -1
+        || _args.findIndex(a => a.toLowerCase() === "-h") > -1) {
+        return showHelp();
+    }
+
     const cwd = process.env.INIT_CWD || require('path').resolve('.');
@@ -79,2 +84,32 @@ let config = process.env;
 
+const showHelp = () => {
+    const isYarn = typeof(process.env["YARN_WRAP_OUTPUT"]) !== "undefined";
+    const isNpx = typeof(process.env["NPX_CLI_JS"]) !== "undefined";
+    const proc = isYarn ? "yarn" : "npx";
+    process.stdout.write("To assist the Single Page App developer in developing client-side applications that leverage DXM for content management purposes.\n\n");
+    process.stdout.write(proc + " crownpeak [--dry-run] [--ignore-circular-dependencies] [--no-components] [--no-pages] [--no-pages] [--no-uploads]\n\n");
+    process.stdout.write("Arguments\n");
+    process.stdout.write("---------\n");
+    process.stdout.write("--dry-run                      - Show what would be created/updated inside the DXM platform if --dry-run were not specified.\n");
+    process.stdout.write("--ignore-circular-dependencies - Instruct the tool to ignore unmet/circular dependency checking before import.\n");
+    process.stdout.write("                                 Errors may be shown when the tool is run if dependencies do not exist within DXM.\n");
+    process.stdout.write("--no-components                - Instruct the tool to not create/update components within the DXM platform.\n");
+    process.stdout.write("--no-pages                     - Instruct the tool to not create/update templates, models or pages within the DXM platform.\n");
+    process.stdout.write("--no-wrappers                  - Instruct the tool to not create/update wrappers within the DXM platform.\n");
+    process.stdout.write("--no-uploads                   - Instruct the tool to not create/update uploads within the DXM platform.\n");
+    process.stdout.write("\n");
+    process.stdout.write("A number of environment variables are expected when running this tool. These can be set directly or provided via a .env file.\n\n");
+    process.stdout.write("Environment variables\n");
+    process.stdout.write("---------------------\n");
+    process.stdout.write("CMS_INSTANCE                 - The CMS instance name to use.\n");
+    process.stdout.write("CMS_USERNAME                 - The username to access the selected CMS instance.\n");
+    process.stdout.write("CMS_PASSWORD                 - The password to access the selected CMS instance.\n");
+    process.stdout.write("CMS_API_KEY                  - The developer key to use with the CMS Access API.\n");
+    process.stdout.write("CMS_SITE_ROOT                - The asset id of the site root in which content items should be created.\n");
+    process.stdout.write("CMS_PROJECT                  - The asset id of the project in which code items should be created.\n");
+    process.stdout.write("CMS_WORKFLOW                 - The id of the workflow with which content items should be associated.\n");
+    process.stdout.write("CMS_STATIC_CONTENT_LOCATION  - The folder in your project where static JSON files can be found.\n");
+    process.stdout.write("CMS_DYNAMIC_CONTENT_LOCATION - A Search G2 query prefix that can be used to locate dynamic content.\n");
+};
+
 const reorderComponents = (components) => {
@@ -81,0 +116,0 @@ let workingSet = components.filter(c => c.dependencies && c.dependencies.length);

package.json

 {
   "name": "crownpeak-dxm-vuejs-sdk",
-  "version": "1.0.4",
+  "version": "2.0.0",
   "description": "Crownpeak Digital Experience Management (DXM) Software Development Kit (SDK) for Vue.js has been constructed to assist the Single Page App developer in developing client-side applications that leverage DXM for content management purposes.",
   "repository": "https://github.com/Crownpeak/DXM-VueJS-SDK",
-  "main": "entry.js",
+  "main": "dist/entry.js",
   "license": "MIT",
@@ -11,3 +11,3 @@ "dependencies": {
     "crownpeak-dxm-accessapi-helper": "^1.0.3",
-    "crownpeak-dxm-sdk-core": "^0.1.3",
+    "crownpeak-dxm-sdk-core": "^2.0.0",
     "dotenv": "^8.2.0",
@@ -18,3 +18,17 @@ "vue": "^2.6.11"
     "crownpeak": "./classes/crownpeak/cmsify.js"
+  },
+  "devDependencies": {
+    "@types/vue": "^2.0.0",
+    "@types/vue-router": "^2.0.0",
+    "prettier": "^2.0.5",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.9.5",
+    "vue-class-component": "^7.2.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json"
   }
 }

README.md

@@ -49,1 +49,2 @@ <a href="https://www.crownpeak.com" target="_blank">![Crownpeak Logo](https://github.com/Crownpeak/DXM-VueJS-SDK/raw/master/images/crownpeak-logo.png?raw=true "Crownpeak Logo")</a>
 | 1.0.4         | 2020JUN17     | Support for list items. Bug fixes.    |
+| 2.0.0         | 2020JUN30     | Migrated to TypeScript.   |

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

78126

increased by35.07%

Number of package files

40

increased by135.29%

Lines of code

1443

increased by26.36%

Number of lines in readme file

50

increased by2.04%

Worsened metrics

Dev dependency count

7

increased byInfinity%

Number of low supply chain risk alerts

14

increased by16.67%

Dependency changes

• + Addedcrownpeak-dxm-sdk-core@2.4.0(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedsax@1.4.1(transitive)

• + Addedxml2js@0.4.23(transitive)

• + Addedxmlbuilder@11.0.1(transitive)

• - Removedcrownpeak-dxm-sdk-core@0.1.3(transitive)

• Updatedcrownpeak-dxm-sdk-core@^2.0.0