Fix: Prepare for publishing

README.md

@@ -1,3 +1,12 @@
+# Microsoft sonarwhal rules
+
+This repository contains rules specific to Microsoft projects.
+
+To know more about each rule package, visit their respective `readme.md`:
+
+* [chisel](./rules/chisel/README.md)
+* [jsll](./rules/jsll/README.md)
+
 # Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a

package-lock.json

@@ -1,3 +0,0 @@
-{
-  "lockfileVersion": 1
-}

rules/chisel/README.md

@@ -1,7 +1,11 @@
-# chisel (`chisel`)
+# Chisel (`chisel`)
 
 Use Chisel to assess the accessibility of a web site or web application.
 
+In order to install this rule you need to be a Microsoft employee and
+have access to the `chisel` registry, otherwise you'll have errors during
+the installation.
+
 ## Can the rule be configured?
 
 Yes, you can configure this rule in your `sonarwhal` configuration file as

rules/chisel/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "",
+  "author": "Microsoft",
   "ava": {
     "babel": {
       "presets": []
@@ -11,7 +11,10 @@
     ],
     "timeout": "1m"
   },
-  "description": "Use Chisel to assess the accessibility of web sites and web applications",
+  "dependencies": {
+    "@mskeros/chisel": "^1.130.1"
+  },
+  "description": "sonarwhal rule to assess the accessibility of a web site using Microsoft's Chisel.",
   "devDependencies": {
     "@types/debug": "0.0.30",
     "@types/node": "8.0.14",
@@ -30,23 +33,35 @@
     "npm-run-all": "^4.1.2",
     "on-headers": "^1.0.1",
     "rimraf": "^2.6.2",
-    "sonarwhal": "^0.22.1",
+    "sonarwhal": "^0.23.1",
     "typescript": "^2.6.2",
     "typescript-eslint-parser": "^12.0.0"
   },
   "engines": {
     "node": ">=8.0.0"
   },
-  "keywords": [
-    "rule",
-    "sonarwhal"
+  "files": [
+    "dist/src",
+    "npm-shrinkwrap.json"
   ],
+  "homepage": "https://sonarwhal.com",
+  "keywords": [
+    "chisel",
+    "rule",
+    "sonarwhal",
+    "sonarwhal-chisel"
+  ],
+  "license": "Apache-2.0",
   "main": "dist/src/index.js",
-  "name": "@sonarwhal/rule-chisel",
+  "name": "sonarwhal-rule-chisel",
+  "peerDependencies": {
+    "sonarwhal": "^0.23.1"
+  },
+  "repository": "Microsoft/sonarwhal-microsoft-rules",
   "scripts": {
     "build": "npm run clean && npm-run-all build:*",
     "build:assets": "cpx \"./{src,tests}/**/{!(*.ts),.!(ts)}\" dist",
-    "build:ts": "tsc --outDir dist --rootDir .",
+    "build:ts": "tsc --outDir \"./dist\"",
     "clean": "rimraf dist",
     "test": "npm run lint && npm run build && ava",
     "lint": "npm-run-all lint:*",
@@ -56,12 +71,5 @@
     "init": "npm install && npm run build",
     "sonarwhal": "node node_modules/sonarwhal/dist/src/bin/sonarwhal.js"
   },
-  "peerDependencies": {
-    "sonarwhal": "^0.22.1"
-  },
-  "dependencies": {
-    "@mskeros/chisel": "^1.127.2"
-  },
-  "repository": "https://github.com/Microsoft/sonarwhal-microsoft-rules",
   "version": "0.1.0"
 }

rules/jsll/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "",
+  "author": "Microsoft",
   "ava": {
     "babel": {
       "presets": []
@@ -11,7 +11,11 @@
     ],
     "timeout": "1m"
   },
-  "description": "Validate the initialization of the JSLL script.",
+  "dependencies": {
+    "locale-code": "^1.1.1",
+    "lodash.clonedeep": "^4.5.0"
+  },
+  "description": "sonarwhal rule to validate Microsoft's JSLL configuration.",
   "devDependencies": {
     "@types/debug": "0.0.30",
     "@types/node": "8.0.14",
@@ -30,23 +34,34 @@
     "npm-run-all": "^4.1.2",
     "on-headers": "^1.0.1",
     "rimraf": "^2.6.2",
-    "sonarwhal": "^0.22.1",
+    "sonarwhal": "^0.23.1",
     "typescript": "^2.6.2",
     "typescript-eslint-parser": "^12.0.0"
   },
   "engines": {
     "node": ">=8.0.0"
   },
-  "keywords": [
-    "rule",
-    "sonarwhal"
+  "files": [
+    "dist/src",
+    "npm-shrinkwrap.json"
   ],
+  "homepage": "https://sonarwhal.com",
+  "keywords": [
+    "jsll",
+    "rule",
+    "sonarwhal",
+    "sonarwhal-rule"
+  ],
+  "license": "Apache-2.0",
   "main": "dist/src/index.js",
   "name": "sonarwhal-rule-jsll",
+  "peerDependencies": {
+    "sonarwhal": "^0.23.1"
+  },
   "scripts": {
     "build": "npm run clean && npm-run-all build:*",
     "build:assets": "cpx \"./{src,tests}/**/{!(*.ts),.!(ts)}\" dist",
-    "build:ts": "tsc --outDir \"./dist\" --rootDir .",
+    "build:ts": "tsc --outDir \"./dist\"",
     "clean": "rimraf dist",
     "test": "npm run lint && npm run build && ava",
     "lint": "npm-run-all lint:*",
@@ -56,13 +71,6 @@
     "init": "npm install && npm run build",
     "sonarwhal": "node node_modules/sonarwhal/dist/src/bin/sonarwhal.js"
   },
-  "peerDependencies": {
-    "sonarwhal": "^0.22.1"
-  },
-  "repository": "https://github.com/Microsoft/sonarwhal-microsoft-rules",
-  "version": "0.1.0",
-  "dependencies": {
-    "locale-code": "^1.1.1",
-    "lodash.clonedeep": "^4.5.0"
-  }
+  "repository": "Microsoft/sonarwhal-microsoft-rules",
+  "version": "0.1.0"
 }

rules/jsll/tsconfig.json

@@ -0,0 +1,22 @@
+{
+    "compilerOptions": {
+        "rootDir": ".",
+        "alwaysStrict": true,
+        "module": "commonjs",
+        "sourceMap": true,
+        "target": "esnext",
+        "declaration": true,
+        "lib": [
+            "es2017",
+            "esnext",
+            "dom",
+            "dom.iterable"
+        ]
+    },
+    "exclude": [
+        "node_modules"
+    ],
+    "include": [
+        "**/*.ts"
+    ]
+}