Merge pull request #489 from Green-Software-Foundation/rename-ie

Rename ie

CONTRIBUTING.md

@@ -72,7 +72,7 @@ feat(lib): initial commit for time-sync logic
 or 
 
 ```
-test(teads-curve): add unit test to check that error is raised on missing tdp param 
+test(lib): in teads-curve add unit test to check that error is raised on missing tdp param 
 ```
 
 Run `npm run fix` before commiting. If your commit message does not conform to the conventional commit specification or if you have not run `npm run fix` your commit will not satisfy the commitlint check.
@@ -133,7 +133,7 @@ Global constants can be given capitalized names, such as `TIME_UNITS_IN_SECONDS`
 
 #### Documentation
 
-Every logical unit (`Class, function, method`) should be covered with appropriate documentation. For documenting such, multi-line comment style is used.
+Every logical unit (`function, method`) should be covered with appropriate documentation. For documenting such, multi-line comment style is used.
 
 ```ts
 ❌ const a = (message: string) => console.log(message)
@@ -145,16 +145,6 @@ Every logical unit (`Class, function, method`) should be covered with appropriat
 const logMessage = (message: string) => console.log(message)
 ```
 
-For documenting variable, expression, single line comments can be used after declaration.
-
-```ts
-class MockClass {
-     // this is a mock field
-  ❌ private mockField: string = "mock-field"
-  ✅ private mockField: string = "mock-field" // Single line documenting style is used.
-}
-```
-
 ### Writing tests
 
 One test file should be responsible for one module. `describe` blocks should be used for module and function/method description. First `describe` should follow `resource/module: ` pattern. Second describe title should follow  `method(): ` pattern. Test units can use `it` blocks whose title should exactly describe behaviour and input argument.

README.md

@@ -61,16 +61,16 @@ Then create a `manifest` file that describes your application (see our docs for
 Then, run `if` using the following command:
 
 ```sh
-if --manifest <path-to-your-manifest-file>
+ie --manifest <path-to-your-manifest-file>
 ```
 
 You can also add an optional savepath for your output yaml (if you do not provide one, the output will be printed to the console):
 
 ```sh
-if --manifest <path-to-your-manifest-file> --output <your-savepath>
+ie --manifest <path-to-your-manifest-file> --output <your-savepath>
 ```
 
-The `if` CLI tool will configure and run the plugins defined in your input `yaml` (`manifest`) and return the results as an output `yaml` (`output`).
+The `ie` CLI tool will configure and run the plugins defined in your input `yaml` (`manifest`) and return the results as an output `yaml` (`output`).
 
 
 ## Documentation

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "v0.2.0",
+  "version": "v0.2.1",
   "author": {
     "name": "Green Software Foundation",
     "email": "[email protected]"
   },
   "bin": {
-    "if": "./build/index.js"
+    "ie": "./build/index.js"
   },
   "bugs": {
     "url": "https://github.com/Green-Software-Foundation/if/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=Feedback+-+"
@@ -62,7 +62,7 @@
     "coverage": "jest --verbose --coverage",
     "fix": "gts fix",
     "fix:package": "fixpack",
-    "if": "npx ts-node src/index.ts",
+    "ie": "npx ts-node src/index.ts",
     "lint": "gts lint",
     "prepare": "husky install",
     "prepublish": "npm run build",

scripts/run-yamls.sh

@@ -4,5 +4,5 @@ echo 'Running all manifests'
 
 for f in ./examples/manifests/*.yml; do 
   echo "Processing $f file..."; 
-  npm run if -- --manifest $f 
+  npm run ie -- --manifest $f 
   done