Merge pull request #8 from scottdurow/dataverse-gen

Dataverse rename!

.cdsify.json → .dataverse-gen.json

@@ -3,6 +3,6 @@
     "actions":[],
     "functions":["RetrieveMetadataChanges"],
     "output":{
-        "outputRoot": "./src/cds-generated"
+        "outputRoot": "./src/dataverse-gen"
     }
 }

.cdsify.template.json → .dataverse-gen.template.json

@@ -3,6 +3,6 @@
     "actions":[],
     "functions":[],
     "output":{
-        "outputRoot": "./src/cds-generated"
+        "outputRoot": "./src/dataverse-gen"
     }
 }

.vscode/tasks.json

@@ -0,0 +1,16 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "build",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"problemMatcher": [],
+			"label": "npm: build",
+			"detail": "tsc"
+		}
+	]
+}

README.md

@@ -1,26 +1,57 @@
-# cdsify-gen
+# dataverse-gen
 
-Creates early bound TypeScript interfaces to work with `cdsify`.
+Creates early bound TypeScript interfaces to work with `dataverse-ify`.
+For more information see the [dataverse-ify project](https://github.com/scottdurow/dataverse-ify/wiki)
 
 ## Usage
 
-1.  Add authentication for your CDS Environment:\
-`~$ npx node-cds-auth [tennant] [environment]`\
+1.  Add authentication for your Microsoft Dataverse Environment:\
+`~$ npx dataverse-auth [environment]`\
 E.g.\
-`~$ npx node-cds-auth contoso.onmicrosoft.com contosoorg.crm.dynamics.com`
+`~$ npx dataverse-auth contosoorg.crm.dynamics.com`
 
-1. Initialise cdsify to create .cdsify.json config file:\
-`~$ npx cdsify-gen init`
+1. Initialise dataverse-ify to create .dataverse-gen.json config file:\
+`~$ npx dataverse-gen init`
 
 1. At any time, you can re-generate the early bound types using:\
-`~$ npx cdsify-gen`
+`~$ npx dataverse-gen`
 
+## `.dataverse-gen.json`
+The configuration for dataverse-gen is stored in the `.dataverse-gen.json` file. You can edit this manually if you want rather than use `npx dataverse-gen init`.  This is the only file that is needed to run `npx dataverse-gen`.
+
+The standard templates use references to the dataverse-ify types, and so unless you edit the templates (see below) you will need to install these types using:
+
+```shell
+npm install --save dataverse-ify
+```
+## Custom Templates
+If you wanted to just generate Attribute `enum` constants and stop there, you can easily customise the scripts to suit your needs by using:
+
+```shell
+npx dataverse-gen eject
+```
+
+This will create a step of templates ready to customise in the `_templates` folder. Once you have made your updates, just run `npx dataverse-gen` again. The templates use the awesome [ejs](https://ejs.co/) project. E.g.
+
+```typescript
+// Attribute constants
+export const enum <%- locals.SchemaName %>Attributes {
+<%locals.Properties && locals.Properties.forEach(function(property){ _%>
+ <%- property.SchemaName %> = "<%- property.Name %>",
+<%})_%>
+}
+```
+
+If you wanted to revert back to the standard templates, just delete the  `_templates` folder
 ## Installing Globally
-If you would rather install cdsify-gen globally you can use:\
-`~$ npm install -g cdsify-gen node-cds-auth`
+If you would rather install dataverse-gen globally you can use:\
+`~$ npm install -g dataverse-gen dataverse-auth`
 
 This will then allow you to simply use:\
-`~$ node-cds-auth`\
-`~$ cdsify-gen`
+`~$ dataverse-auth`\
+`~$ dataverse-gen`
+
+For more information see the [dataverse-ify project](https://github.com/scottdurow/dataverse-ify/wiki)
 
-For more information see the [cdsify project](https://github.com/scottdurow/cdsify/wiki)
+Notes:
+1. Files differ by case only. If you get an error from the imports in the generated types, it is likely that your file names have the wrong case. dataverse-gen will remember re-use the file name if it exsts when generating - even if the casing is different. The solution is to completely remove all your generated files and regenerated them to get the correct casing.

_templates/entity.ejs

@@ -28,7 +28,7 @@ export const <%- Name %>Metadata = {
 };
 
 // Attribute constants
-export enum <%- locals.SchemaName %>Attributes {
+export const enum <%- locals.SchemaName %>Attributes {
 <%locals.Properties && locals.Properties.forEach(function(property){ _%>
   <%- property.SchemaName %> = "<%- property.Name %>",
 <%})_%>