@itwin/ecschema2ts 3.0.0-extension.1 → 3.1.0-dev.6

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -1,13 +1,13 @@
 # ecschema2ts
 
-ecschema2ts is a command-line tool that takes an EC3.1/EC3.2 BIS ECSchema xml file and outputs a valid Typescript module that uses iModelJs.
+ecschema2ts is a command-line tool that takes an EC3.1/EC3.2 BIS ECSchema xml file and outputs a valid Typescript module that uses iTwin.js.
 
 ## Quick Overview
 
 ```sh
-$ npm install -g @itwin/ecschema2ts
+npm install -g @itwin/ecschema2ts
 
-$ ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path\
+ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path\
 ```
 
 ## Getting Started
@@ -17,7 +17,7 @@ $ ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path
 Install globally:
 
 ```sh
-$ npm install -g @itwin/ecschema2ts
+npm install -g @itwin/ecschema2ts
 ```
 
 ### Creating a Typescript module
@@ -25,7 +25,7 @@ $ npm install -g @itwin/ecschema2ts
 To create a Typescript file from the an ECSchema, run:
 
 ```sh
-$ ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path\
+ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path\
 ```
 
 ## Updating to new version
@@ -33,7 +33,7 @@ $ ecschema2ts -i C:\Path\To\Schema\Domain.ecschema.xml -o C:\Desired\Output\Path
 Since the package is installed globally, updating has a different syntax than normal. To update the package globally, run:
 
 ```sh
-$ npm update -g @itwin/ecschema2ts
+npm update -g @itwin/ecschema2ts
 ```
 
 ## Known Issues

package/package.json

@@ -2,7 +2,7 @@
   "name": "@itwin/ecschema2ts",
   "description": "Command line tools that takes an ECSchema xml file and outputs a typescript module",
   "license": "MIT",
-  "version": "3.0.0-extension.1",
+  "version": "3.1.0-dev.6",
   "bin": {
     "ecschema2ts": "./bin/index.js"
   },
@@ -14,7 +14,7 @@
   "keywords": [
     "Bentley",
     "iModel",
-    "iModelJs",
+    "iTwin.js",
     "EC",
     "BIS"
   ],
@@ -23,8 +23,8 @@
     "url": "http://www.bentley.com"
   },
   "devDependencies": {
-    "@itwin/build-tools": "3.0.0-extension.1",
-    "@itwin/eslint-plugin": "3.0.0-extension.1",
+    "@itwin/build-tools": "3.1.0-dev.6",
+    "@itwin/eslint-plugin": "3.1.0-dev.6",
     "@types/chai": "^4.1.4",
     "@types/chai-string": "^1.4.1",
     "@types/fs-extra": "^4.0.7",
@@ -32,7 +32,7 @@
     "@types/node": "14.14.31",
     "chai": "^4.1.2",
     "chai-string": "^1.5.0",
-    "cpx": "^1.5.0",
+    "cpx2": "^3.0.0",
     "eslint": "^7.11.0",
     "mocha": "^8.3.2",
     "nyc": "^15.1.0",
@@ -41,12 +41,12 @@
     "typescript": "~4.4.0"
   },
   "dependencies": {
-    "@itwin/core-bentley": "3.0.0-extension.1",
-    "@itwin/ecschema-locaters": "3.0.0-extension.1",
-    "@itwin/ecschema-metadata": "3.0.0-extension.1",
-    "@itwin/core-geometry": "3.0.0-extension.1",
-    "@itwin/core-backend": "3.0.0-extension.1",
-    "@itwin/core-common": "3.0.0-extension.1",
+    "@itwin/core-bentley": "3.1.0-dev.6",
+    "@itwin/ecschema-locaters": "3.1.0-dev.6",
+    "@itwin/ecschema-metadata": "3.1.0-dev.6",
+    "@itwin/core-geometry": "3.1.0-dev.6",
+    "@itwin/core-backend": "3.1.0-dev.6",
+    "@itwin/core-common": "3.1.0-dev.6",
     "@xmldom/xmldom": "^0.7.0",
     "chai-string": "^1.5.0",
     "chalk": "^3.0.0",
@@ -74,5 +74,6 @@
     "test": "mocha",
     "cli:dev": "npm run -s clean & npm run -s build & npm link",
     "cover": "nyc npm -s test"
-  }
+  },
+  "readme": "# ecschema2ts\r\n\r\necschema2ts is a command-line tool that takes an EC3.1/EC3.2 BIS ECSchema xml file and outputs a valid Typescript module that uses iTwin.js.\r\n\r\n## Quick Overview\r\n\r\n```sh\r\nnpm install -g @itwin/ecschema2ts\r\n\r\necschema2ts -i C:\\Path\\To\\Schema\\Domain.ecschema.xml -o C:\\Desired\\Output\\Path\\\r\n```\r\n\r\n## Getting Started\r\n\r\n### Installation\r\n\r\nInstall globally:\r\n\r\n```sh\r\nnpm install -g @itwin/ecschema2ts\r\n```\r\n\r\n### Creating a Typescript module\r\n\r\nTo create a Typescript file from the an ECSchema, run:\r\n\r\n```sh\r\necschema2ts -i C:\\Path\\To\\Schema\\Domain.ecschema.xml -o C:\\Desired\\Output\\Path\\\r\n```\r\n\r\n## Updating to new version\r\n\r\nSince the package is installed globally, updating has a different syntax than normal. To update the package globally, run:\r\n\r\n```sh\r\nnpm update -g @itwin/ecschema2ts\r\n```\r\n\r\n## Known Issues\r\n\r\n- The ordering of the Typescript classes may be out of order preventing compilation of the typescript file. A workaround is to reorder the classes by hand.\r\n\r\n## Troubleshooting\r\n\r\n- Are you have issues converting your ECSchema?\r\n  - Check to make sure your ECSchema version is EC3.1\r\n  - Check if the BIS ECSchema passes validation, [check ECSchema status](https://bentley.sharepoint.com/sites/BIS/Lists/Schema%20Development%20Status/AllItems.aspx?viewpath=%2Fsites%2FBIS%2FLists%2FSchema%20Development%20Status%2FAllItems.aspx).\r\n"
 }