@mchp-mcc/scf-pic8-pwm-v2 4.2.3 → 4.2.4

package/Changelog.md

@@ -0,0 +1,7 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [4.2.4] - 2022-03-23
+
+### New Features
+- **CC8SCRIP-7662** :- Added Analytics support

package/Readme.md

@@ -1,4 +1,54 @@
+# SCF Auto-Module Workflow
+## Prerequisites:
+- Download & Install [nodejs](https://nodejs.org/en/download/)
+- Download & Install [yarn](https://yarnpkg.com/) (Depends on Node.js)
+- Download & Install [JRE 8u201](https://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase8-2177648.html) (We have tested with 8u201, but it will probably work with others if you have a newer version.)
+- Setup node, yarn, & java in enviroment path
+- Download & Install a Code Editor. We are using [VSCode](https://code.visualstudio.com/download)
+
+- Run the following commands to set your registry to our internal artifactory server. This only needs to be done once per machine:
+    - `yarn config set registry https://artifacts.microchip.com/artifactory/api/npm/npm/`
+    - `npm config set registry https://artifacts.microchip.com/artifactory/api/npm/npm/`
+
+
+## Setup
+- cd to the project root
+- run the following commands:
+    - `yarn install`
+        - this downloads all of the project dependencies to your machine
+    - `yarn build-run-dir`
+        - this builds a run directory in your project
+        - if download fails, checkout and build [Scripted Content Framework](https://bitbucket.microchip.com/projects/MCC/repos/scripts/browse)
+        and copy the generated run folder to your project's root directory
+
+### Hardware Module
+- A hardware file should already be created in the next step as long as you followed the prompts when running create scf-module, but in case you need to add a peripheral later follow the next step:
+- create a file called `peripheral.json` in the src directory. Place a JSON object copied from the device and peripheral you wish to use for this project
+  
+
+### Compile & Build
+- `yarn create-auto-module`
+    - Generates a `moduleConfig.json` file and creates a set of files in the generated_module directory specific to the data in `src/peripheral.json`.
+    -`moduleConfig.json` can now be modified to customize your project.
+- `yarn build`
+    - Builds the project and distributes the output files to the run directory. This also runs `create-auto-module` as part of the build process
+- `yarn start`
+    - Creates a watcher on the project that detects changes in the source files. When a change is detected, a short compilation is performed and the new files are distributed. It is intended to speed up the design process.
+- In a different terminal open MCC by running `./launch` on unix / linux or .`/launch.bat` on windows. Update the default device indicated in the launch file to your desired device.
+Under Device Resources you should see your module.
+
+### Unit Tests
+
+- `yarn test`
+    - Triggers all the unit test cases specified by any file ending in .test.ts
+    - Unit test report is available at coverage/lcov-report/index.html
+
+
+
 # Changelog
+All notable changes to this project will be documented in this file.
+
+## [4.2.4] - 2022-03-23
 
-## [4.2.3]
-   - Initial release version.
+### New Features
+- **CC8SCRIP-7662** :- Added Analytics support

package/lib/generated_module/src/index.js

@@ -3,14 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.hooks = void 0;
 var processor_1 = require("./processor");
 var creator_1 = require("./creator");
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-var packageJson = require("../../../package.json");
 exports.hooks = {
     process: processor_1.process,
     create: creator_1.create,
     reducer: "auto",
-    displayName: packageJson.scf.displayName,
-    category: packageJson.scf.category,
-    views: packageJson.scf.views,
 };
 //# sourceMappingURL=index.js.map