add the --tsIndexFiles switch and generate the index.ts entry file to…

… add descriptions to module topics (#100)

* wip: entry file to add descriptions to module topics

* wip: add the --tsIndexFiles switch and generate index.ts

* wip: remove static copy of index .ts to avoid build error - we don't need to build it

.gitignore

@@ -17,4 +17,5 @@ node.exe
 manifest.itsyn.yml
 
 # documentation
-documentation/file.json
+documentation/file.json
+documentation/index.ts

package.json

@@ -25,7 +25,7 @@
     "test:standalone": "npm run build && nyc mocha --grep standalone",
     "test:integration": "npm run build && nyc mocha --grep integration",
     "test:connector": "node lib/test/TestConnector/Main.js test/assets/TestArgs.json",
-    "documentation": "cross-env RUSHSTACK_FILE_ERROR_BASE_FOLDER=$npm_config_local_prefix betools docs --source=./src --out=./documentation --json=./documentation/file.json --onlyJson"
+    "documentation": "cross-env RUSHSTACK_FILE_ERROR_BASE_FOLDER=$npm_config_local_prefix betools docs --source=./src --out=./documentation --json=./documentation/file.json --tsIndexFile=./connector-framework.ts --onlyJson"
 
   },
   "keywords": [

src/connector-framework.ts

@@ -7,3 +7,50 @@ export * from "./LoggerCategory";
 export * from "./ConnectorRunner";
 export * from "./BaseConnector";
 export * from "./Synchronizer";
+
+/** @docs-package-description
+ * The connector-framework package contains classes for [authoring iTwin Connectors]($docs/learning/WriteAConnector.md).
+ */
+
+/**
+ * @docs-group-description Args
+ * Classes for storing the command line arguments for an iTwin Connector.
+ */
+
+/**
+ * @docs-group-description BaseConnector
+ * The base class for all iTwin Connectors.
+ */
+
+/**
+ * @docs-group-description ConnectorIssueReporter
+ * Class for reporting an iTwin Connector's status and/or errors back to orchestrators or othe callers/launchers of Connectors.
+ */
+
+
+/**
+ * @docs-group-description ConnectorRunner
+ * Class responsible for loading the connector from a JavaScript source file and running it.
+ */
+
+
+/**
+ * @docs-group-description Framework
+ * Class describing the overall package as an aggregation of the various component classes: ConnectorRunner, BaseConnector, Synchronizer, etc.
+ */
+
+
+/**
+ * @docs-group-description LoggerCategories
+ * Enumeration for all logger categories in this package.
+ */
+
+
+/**
+ * @docs-group-description SqliteIssueReporter
+ * A Subclass of a ConnectorIssueReporter for SQLite related issues.
+ */
+
+
+
+