ts2famix 1.0.10 → 1.0.12

package/.eslintrc.json

@@ -1,24 +1,24 @@
-{
-    "env": {
-        "browser": true,
-        "es2021": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "overrides": [
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-        "@typescript-eslint/no-namespace": "off",
-        "semi": [1, "always"]
-    }
-}
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-namespace": "off",
+        "semi": [1, "always"]
+    }
+}

package/LICENSE

@@ -1,23 +1,23 @@
-MIT License
-
-Copyright (c) 2021 Arezoo Nasrollah Zadeh
-Copyright (c) 2021 Christopher Fuhrman
-Copyright (c) 2023 Maël Paul
-
-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:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Arezoo Nasrollah Zadeh
+Copyright (c) 2021 Christopher Fuhrman
+Copyright (c) 2023 Maël Paul
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,109 +1,109 @@
-# FamixTypeScriptImporter
-
-[![Node.js CI](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml/badge.svg)](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml)
-
-Create a [FamixTypeScript](https://github.com/fuhrmanator/FamixTypeScript) model in JSON of TypeScript files.
-
-## Installation
-
-```sh
-npm install ts2famix
-```
-
-## Usage
-
-Instructions for using the command-line importer:
-
-```sh
-ts2famix --help
-```
-
-## Parse a full project
-
-```sh
-ts2famix -i ../path/to/project/tsconfig.json -o JSONModels/projectName.json
-```
-or
-```sh
-ts2famix -i "../path/to/project/**/*.ts" -o JSONModels/projectName.json
-```
-
-## Import the JSON model into Moose 🫎
-
-You need to copy the "```JSONModels/projectName.json```" into your "```Pharo/images/[imageName]```" directory.
-
-For a Moose Suite 10 (stable) user with the Pharo directory in the root directory, do : 
-```sh
-cp JSONModels/projectName.json ~/Pharo/images/Moose\ Suite\ 10\ \(stable\)/.
-```
-
-Then, in a Moose Playground, do :
-```st
-Metacello new 
-  githubUser: 'fuhrmanator' project: 'FamixTypeScript' commitish: 'master' path: 'src';
-  baseline: 'FamixTypeScript';
-  load
-```
-
-This command installs the TypeScript metamodel into Moose.
-
-Then, generate the metamodel with :  
-```Library > Famix > Manage metamodels > Regenerate all metamodels```
-
-Then, in a Moose Playground, do :
-```st
-'projectName.json' asFileReference readStreamDo:
-  [ :stream | model := FamixTypeScriptModel new 
-    importFromJSONStream: stream. model install ].
-```
-
-This command imports the JSON model into Moose.
-
-## Developer info
-
-Run tests :
-```sh
-npm test
-```
-
-Generate coverage :
-```sh
-npm run coverage
-```
-
-Then, open "```coverage/lcov-report/index.html```" with your favorite browser : 
-```sh
-firefox coverage/lcov-report/index.html &
-```
-
-Generate documentation :
-```sh
-npm run doc
-```
-
-Then, open "```docs/index.html```" with your favorite browser : 
-```sh
-firefox docs/index.html &
-```
-
-Generate plantuml and svg of the metamodel :
-```sh
-npm run uml
-```
-
-Then, open "```doc-uml/metamodel.svg```" with your favorite image viewer :
-```sh
-eog doc-uml/metamodel.svg &
-```
-
-## Generate an object diagram of the JSON model
-
-```sh
-ts-node src/famix2puml.ts -i JSONModels/projectName.json -o PUMLModels/projectName.puml
-```
-
-## TypeScript Metamodel API documentation (visualization)
-
-The following was generated by CI using [tplant](https://github.com/bafolts/tplant), in a similar fashion described [here](https://modularmoose.org/2021/07/19/automatic-metamodel-documentation-generation.html).
-
-![FamixTypeScript API Metamodel](https://raw.githubusercontent.com/maelpaul/FamixTypeScriptImporter/v1/doc/metamodel.svg)
+# FamixTypeScriptImporter
+
+[![Node.js CI](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml/badge.svg)](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml)
+
+Create a [FamixTypeScript](https://github.com/fuhrmanator/FamixTypeScript) model in JSON of TypeScript files.
+
+## Installation
+
+```sh
+npm install ts2famix
+```
+
+## Usage
+
+Instructions for using the command-line importer:
+
+```sh
+ts2famix --help
+```
+
+## Parse a full project
+
+```sh
+ts2famix -i ../path/to/project/tsconfig.json -o JSONModels/projectName.json
+```
+or
+```sh
+ts2famix -i "../path/to/project/**/*.ts" -o JSONModels/projectName.json
+```
+
+## Import the JSON model into Moose 🫎
+
+You need to copy the "```JSONModels/projectName.json```" into your "```Pharo/images/[imageName]```" directory.
+
+For a Moose Suite 10 (stable) user with the Pharo directory in the root directory, do : 
+```sh
+cp JSONModels/projectName.json ~/Pharo/images/Moose\ Suite\ 10\ \(stable\)/.
+```
+
+Then, in a Moose Playground, do :
+```st
+Metacello new 
+  githubUser: 'fuhrmanator' project: 'FamixTypeScript' commitish: 'master' path: 'src';
+  baseline: 'FamixTypeScript';
+  load
+```
+
+This command installs the TypeScript metamodel into Moose.
+
+Then, generate the metamodel with :  
+```Library > Famix > Manage metamodels > Regenerate all metamodels```
+
+Then, in a Moose Playground, do :
+```st
+'projectName.json' asFileReference readStreamDo:
+  [ :stream | model := FamixTypeScriptModel new 
+    importFromJSONStream: stream. model install ].
+```
+
+This command imports the JSON model into Moose.
+
+## Developer info
+
+Run tests :
+```sh
+npm test
+```
+
+Generate coverage :
+```sh
+npm run coverage
+```
+
+Then, open "```coverage/lcov-report/index.html```" with your favorite browser : 
+```sh
+firefox coverage/lcov-report/index.html &
+```
+
+Generate documentation :
+```sh
+npm run doc
+```
+
+Then, open "```docs/index.html```" with your favorite browser : 
+```sh
+firefox docs/index.html &
+```
+
+Generate plantuml and svg of the metamodel :
+```sh
+npm run uml
+```
+
+Then, open "```doc-uml/metamodel.svg```" with your favorite image viewer :
+```sh
+eog doc-uml/metamodel.svg &
+```
+
+## Generate an object diagram of the JSON model
+
+```sh
+ts-node src/famix2puml.ts -i JSONModels/projectName.json -o PUMLModels/projectName.puml
+```
+
+## TypeScript Metamodel API documentation (visualization)
+
+The following was generated by CI using [tplant](https://github.com/bafolts/tplant), in a similar fashion described [here](https://modularmoose.org/2021/07/19/automatic-metamodel-documentation-generation.html).
+
+![FamixTypeScript API Metamodel](https://raw.githubusercontent.com/maelpaul/FamixTypeScriptImporter/v1/doc/metamodel.svg)