Move config parser into a separate package (#51)

* move parser into external package

* add readme

* remove old dependencies

* update ci script

* no ci flag

* add build step

Author: pavelvlasov

.circleci/config.yml

@@ -14,14 +14,15 @@ jobs:
                       - v3-dependencies-
 
             - run: sudo npm install lerna -g
+            - run: lerna bootstrap --no-ci
             - run: npm install
-            - run: lerna bootstrap
 
             - save_cache:
                   paths:
                       - node_modules
                   key: v3-dependencies-{{ checksum "package-lock.json" }}
 
+            - run: npm run build
             - run: npm run lint:types
             - run: npm run lint:ts
             - run: npm test

.eslintignore

@@ -1,2 +1,2 @@
 **/node_modules/**
-**/out/**
+**/dist/**

.eslintrc.js

@@ -1,6 +1,6 @@
 module.exports = {
 	parser: "@typescript-eslint/parser",
-	plugins: ["@typescript-eslint"],
+	plugins: ["@typescript-eslint", "simple-import-sort"],
 	extends: [
 		"plugin:@typescript-eslint/recommended",
 		"prettier/@typescript-eslint",
@@ -13,6 +13,7 @@ module.exports = {
 	rules: {
 		"no-console": 2,
 		"prettier/prettier": "error",
+		"simple-import-sort/sort": "error",
 		"@typescript-eslint/explicit-member-accessibility": [
 			2,
 			{
@@ -26,6 +27,8 @@ module.exports = {
 		"@typescript-eslint/interface-name-prefix": 0,
 		"@typescript-eslint/explicit-function-return-type": "off",
 		"@typescript-eslint/no-non-null-assertion": "off",
-		"@typescript-eslint/no-use-before-define": "off"
+		"@typescript-eslint/no-use-before-define": "off",
+		"sort-imports": "off",
+		"import/order": "off"
 	}
 }

.gitignore

@@ -1,5 +1,6 @@
 **/node_modules
 node_modules
-**/out
+**/dist
 *.log
-*.vsix
+*.vsix
+.cache

.vscode/launch.json

@@ -13,9 +13,9 @@
 			"stopOnEntry": false,
 			"sourceMaps": true,
 			"outFiles": [
-				"${workspaceRoot}/packages/vscode/out/**/*.js"
+				"${workspaceRoot}/packages/vscode/dist/**/*.js"
 			],
-			"preLaunchTask": "compile"
+			"preLaunchTask": "build"
 		},
 		{
 			"name": "Attach Server",
@@ -24,7 +24,7 @@
 			"port": 6009,
 			"sourceMaps": true,
 			"outFiles": [
-				"${workspaceRoot}/packages/server/out/server/**/*.js"
+				"${workspaceRoot}/packages/language-server/dist/**/*.js"
 			],
 			"protocol": "inspector",
 			"trace": true

.vscode/tasks.json

@@ -2,28 +2,10 @@
 	"version": "2.0.0",
 	"tasks": [
 		{
-			"label": "Watch client",
+			"label": "build",
 			"type": "shell",
-			"command": "lerna run --scope serverless-ide-vscode watch",
-			"group": "build"
-		},
-		{
-			"label": "compile",
-			"type": "shell",
-			"command": "lerna run --scope serverless-ide-vscode compile; and lerna run --scope @serverless-ide/language-server compile",
-			"group": "build"
-		},
-		{
-			"label": "Compile client",
-			"type": "shell",
-			"command": "lerna run --scope serverless-ide-vscode compile",
-			"group": "build"
-		},
-		{
-			"label": "Compile server",
-			"type": "shell",
-			"command": "lerna run --scope @serverless-ide/language-server compile",
+			"command": "lerna run build",
 			"group": "build"
 		}
 	]
-}
+}

README.md

@@ -1,7 +1,6 @@
 [![Marketplace Version](https://vsmarketplacebadge.apphb.com/version/ThreadHeap.serverless-ide-vscode.svg 'Current Release')](https://marketplace.visualstudio.com/items?itemName=ThreadHeap.serverless-ide-vscode)
 [![Rating](https://vsmarketplacebadge.apphb.com/rating-star/ThreadHeap.serverless-ide-vscode.svg 'Current Release')](https://marketplace.visualstudio.com/items?itemName=ThreadHeap.serverless-ide-vscode)
 [![Installs](https://vsmarketplacebadge.apphb.com/installs/ThreadHeap.serverless-ide-vscode.svg 'Current Release')](https://marketplace.visualstudio.com/items?itemName=ThreadHeap.serverless-ide-vscode)
-[![Downloads](https://vsmarketplacebadge.apphb.com/downloads/ThreadHeap.serverless-ide-vscode.svg 'Current Release')](https://marketplace.visualstudio.com/items?itemName=ThreadHeap.serverless-ide-vscode)
 
 # Serverless IDE: Enhanced support of AWS SAM, CloudFormation and Serverless Framework in Visual Studio Code
 
@@ -83,10 +82,6 @@ IMPORTANT: This option requires a restart of VS Code to take effect.
 
 NOTE: We also respect the global telemetry setting telemetry.enableTelemetry; if that is set to false, ServerlessIDE telemetry is disabled. For more information see [Microsoft’s documentation](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting).
 
-## Contributions
-
-You can find [the code on GitHub repository](https://github.com/threadheap/serverless-ide-vscode)
-
 ## Questions and feedback
 
 Feature requests and feedback are very appreciated
@@ -98,6 +93,33 @@ Check out [public roadmap board](https://github.com/threadheap/serverless-ide-vs
 DM or follow me on [twitter](https://twitter.com/pvl4sov) or [medium](https://medium.com/@pvlasov)
 or contact [by email](mailto:[email protected])
 
+## Contributions
+
+You can find [the code on GitHub repository](https://github.com/threadheap/serverless-ide-vscode)
+
+### Setup
+
+The project is split between packages backed by lerna.
+You can explore source code in `packages` folder.
+
+#### Prerequisites
+
+NodeJS >= 8.x
+VSCode
+
+```sh
+npm install lerna -g
+npm install
+lerna bootstrap
+```
+
+#### Test run
+
+To test your changes in VSCode
+
+Use `Launch Extension` command to build and start extension
+Use `Attach Server` command to attach debugger
+
 ### Author
 
 [Pavel Vlasov](https://github.com/pavelvlasov)

jest.config.js

@@ -6,6 +6,9 @@ module.exports = {
 	],
 	testMatch: ["**/__tests__/**/?(*.)+(spec|test).+(ts|js)"],
 	modulePathIgnorePatterns: ["node_modules"],
+	moduleNameMapper: {
+		"@serverless-ide/(.*)$": "<rootDir>/packages/$1"
+	},
 	preset: "ts-jest",
 	testEnvironment: "node",
 	verbose: false

lerna.json

@@ -9,4 +9,4 @@
 		"*.txt",
 		"lerna.json"
 	]
-}
+}

package-lock.json

@@ -11,6 +11,7 @@
         "eslint": "^6.0.1",
         "eslint-config-prettier": "^6.0.0",
         "eslint-plugin-prettier": "^3.1.0",
+        "eslint-plugin-simple-import-sort": "^4.0.0",
         "husky": "^1.3.1",
         "jest": "^23.6.0",
         "lerna": "^3.15.0",
@@ -25,7 +26,7 @@
         "test": "jest",
         "test:changed": "jest --bail --findRelatedTests",
         "pre-commit": "./node_modules/.bin/lint-staged",
-        "compile": "lerna run compile",
+        "build": "lerna run build",
         "lint:types": "lerna run lint:types",
         "lint:ts": "eslint **/*.ts",
         "lint:ts:fix": "eslint **/*.ts --fix"

package.json

@@ -2,7 +2,7 @@
     "name": "@serverless-ide/cloudformation-schema",
     "version": "0.5.0",
     "description": "Json schema for AWS SAM template configuration",
-    "main": "out/index.js",
+    "main": "dist/index.js",
     "repository": "[email protected]:threadheap/aws-sam-json-schema.git",
     "author": "Pavel Vlasov <[email protected]>",
     "keywords": [
@@ -30,14 +30,14 @@
         "@types/request-promise": "^4.1.42"
     },
     "scripts": {
-        "build": "rm -rf ./out && tsc -p .",
-        "lint:types": "tsc --noEmit",
-        "watch": "rm -rf ./out && npm run build --watch",
-        "generate": "npm run build && node out/index.js",
-        "prepublish": "npm run generate"
+        "build": "npm run clean && npm run compile && node dist/index.js",
+        "clean": "rm -rf ./dist",
+        "compile": "tsc",
+        "prepublishOnly": "npm run generate",
+        "lint:types": "tsc --noEmit"
     },
     "publishConfig": {
         "access": "public"
     },
     "gitHead": "4bc5eddda35b9e7cc28f2580da1960b017881f33"
-}
+}

packages/cloudformation-schema/package.json

@@ -1,16 +1,9 @@
 {
+    "extends": "../../tsconfig.base.json",
     "compilerOptions": {
-        "target": "es6",
-        "moduleResolution": "node",
-        "module": "commonjs",
-        "strict": true,
-        "outDir": "./out",
-        "declaration": true
+        "outDir": "dist"
     },
     "include": [
         "src"
-    ],
-    "exclude": [
-        "out"
     ]
 }

packages/cloudformation-schema/tsconfig.json

@@ -0,0 +1,4 @@
+src/
+test/
+tsconfig.json
+jest.config.js