Merge pull request #52 from ember-template-lint/add-set

Add a recommended set of rules

Author: dcyriller

README.md

@@ -24,29 +24,22 @@ yarn add -D prettier ember-template-lint-plugin-prettier
 
 As peerDependencies, `prettier` and `ember-template-lint` will have to be installed in your project. Prettier version local to the project will be used (not any global one!).
 
-Also, this plugin doesn't come with a recommended set of rules (that you often provide in the `extends` config key). At least for today! You'll have to enable them manually (see "Recommended configuration").
-
 ## Recommended configuration
 
-You can merge your existing `.template-lintrc.js` configuration with this object:
+A recommended configuration is available. To use it, merge the following object
+to your `.templatelintrc.js` file:
 
 ```
 module.exports = {
   plugins: ["ember-template-lint-plugin-prettier"],
 
-  rules: {
-    prettier: true, // turn this plugin's rule on
-
-     // if you use ember-template-lint's recommended set of rules
-     // through `extends: "recommended"`,
-     // these two rules need to be disabled
-     // to let Prettier handle formatting
-    "block-indentation": false,
-    "self-closing-void-elements": false,
+  extends: ["recommend", "ember-template-lint-plugin-prettier:recommended"],
   },
 };
 ```
 
+The recommended set will apply [these rules](https://github.com/ember-template-lint/ember-template-lint-plugin-prettier/blob/v1.1.0-beta.0/lib/config/recommended.js).
+
 ## Warnings
 
 #### General

ember-template-lint-plugin-prettier.js

@@ -1,8 +1,14 @@
-const PrettierRule = require("./rules/lint-prettier");
+const PrettierRule = require("./lib/rules/prettier");
 
 module.exports = {
   name: "ember-template-lint-plugin-prettier",
 
+  configurations: {
+    recommended: {
+      rules: require("./lib/config/recommended")
+    }
+  },
+
   rules: {
     prettier: PrettierRule
   }

lib/config/recommended.js

@@ -0,0 +1,10 @@
+"use strict";
+
+module.exports = {
+  prettier: true,
+  // ember-template-lint stylistic rules
+  "block-indentation": false,
+  "linebreak-style": false,
+  quotes: false,
+  "self-closing-void-elements": false
+};

rules/lint-prettier.js lib/rules/prettier.jsrules/lint-prettier.js renamed to lib/rules/prettier.js

@@ -1,6 +1,6 @@
 {
   "name": "ember-template-lint-plugin-prettier",
-  "version": "1.0.0",
+  "version": "1.1.0-beta.0",
   "description": "A prettier plugin for ember-template-lint",
   "keywords": [
     "ember-template-lint",
@@ -11,8 +11,7 @@
   ],
   "files": [
     "ember-template-lint-plugin-prettier.js",
-    "rules",
-    "utils",
+    "lib",
     "docs"
   ],
   "main": "ember-template-lint-plugin-prettier.js",

utils/get-loc-from-index.js lib/utils/get-loc-from-index.jsutils/get-loc-from-index.js renamed to lib/utils/get-loc-from-index.js

@@ -1,6 +1,6 @@
 /* eslint node/no-deprecated-api: 'off' */
 const assert = require("assert");
-const getLocFromIndex = require("../../../utils/get-loc-from-index");
+const getLocFromIndex = require("../../../lib/utils/get-loc-from-index");
 
 describe("getLocFromIndex()", function() {
   describe("when end-of-file === newline", function() {