closes #639

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 > This page is part of the [App Framework Documentation](DOCUMENTATION.md)
 
+## Next version
+
+### New features
+
+- [x] [#639 - Add .editorconfig file](https://github.com/scriptPilot/app-framework/issues/639) ([read the docs](https://github.com/scriptPilot/app-framework/blob/master/docs/software.md))
+
 ## Version 1.16.18
 
 Released on 2017-10-29

config-scheme.json

@@ -188,6 +188,20 @@
     "type": "boolean",
     "default": false
   },
+  "editorConfig": {
+    "type": "object",
+    "default": {
+      "root": "true",
+      "[*]": null,
+      "indent_style": "space",
+      "indent_size": "2",
+      "charset": "utf-8",
+      "trim_trailing_whitespace": "true",
+      "insert_final_newline": "true",
+      "end_of_line": "lf",
+      "max_line_length": "null"
+    }
+  },
   "eslint": {
     "props": {
       "extends": {

demo/config.json

@@ -57,6 +57,17 @@
   "resetLocalStorageOnVersionChange": false,
   "preloadImages": true,
   "buildSourcemaps": false,
+  "editorConfig": {
+    "root": "true",
+    "[*]": null,
+    "indent_style": "space",
+    "indent_size": "2",
+    "charset": "utf-8",
+    "trim_trailing_whitespace": "true",
+    "insert_final_newline": "true",
+    "end_of_line": "lf",
+    "max_line_length": "null"
+  },
   "eslint": {
     "extends": "standard",
     "rules": {}

docs/software.md

@@ -18,6 +18,7 @@ First of all, you need a code editor. We really recommend Atom, which is open so
 6. Search for package `language-vue-component` and click on *install*
 7. Close the settings tab and Atom itself
 
+An *.editorconfig* file will be created / updated automatically. You can configure it in the *app/config.json* file, item `editorConfig`. To write a line without value, for example `[*]`, assign value `null`, else assign value as string or number.
 
 ## Node.js
 

scripts/update-ignore-files.js

@@ -18,7 +18,8 @@ const gitIgnore = {
   'zip files (deprecated)': '*.zip',
   'database backups (deprecated)': 'database-backup.json',
   'FTP config file': 'ftp-config.json',
-  'ESLint configuration file': '.eslintrc'
+  'ESLint configuration file': '.eslintrc',
+  'Editor configuration file': '.editorconfig'
 }
 
 const npmIgnore = JSON.parse(JSON.stringify(gitIgnore))

scripts/updateEditorConfigFile.js

@@ -0,0 +1,23 @@
+// Purpose: Update .editorconfig file according app/config.json
+
+// Import modules
+const env = require('./env')
+const fs = require('fs-extra')
+const path = require('path')
+
+// Check availability of the config
+if (!env.cfg.editorConfig) throw new Error('Missing editorConfig item in config.json file.')
+
+// Create file content
+let content = ''
+
+// Loop config options
+for (let item in env.cfg.editorConfig) {
+  content = content + item + (env.cfg.editorConfig[item] ? ' = ' + env.cfg.editorConfig[item] : '') + '\n'
+}
+
+// Create/update .editorconfig file
+fs.writeFile(path.resolve(env.app, '.editorconfig'), content, (err) => {
+  if (err) throw err
+  console.log('.editorconfig file updated.')
+})