Code style tooling (php and JS)

Author: b-richard

.editorconfig

@@ -0,0 +1,14 @@
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines
+[*]
+end_of_line = LF
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+charset = utf-8
+insert_final_newline = true
+
+[*.php]
+

.php_cs.dist

@@ -5,5 +5,11 @@ return PhpCsFixer\Config::create()
         '@PSR1' => true,
         '@PSR2' => true,
         'array_syntax' => ['syntax' => 'short'],
+        'protected_to_private' => false,
     ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__.'/src')
+            ->append(array(__FILE__))
+    )
 ;

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    "printWidth": 120,
+    "semi": false,
+    "single-quote": true,
+    "tabWidth": 4,
+    "trailing-comma": "all",
+}

README.md

@@ -127,14 +127,25 @@ Also, if you want to use the asset server finely, you have to add the assets con
 `json_manifest_path: '%kernel.project_dir%/public/build/manifest.json'`. In fact the npm command will build asset in memory only, and modify the manifest file to map asset to a new url served by the asset server instead of the main web server.
 
 # code quality
+## PHP
+The project uses 2 packages to lint and fix the code style of PHP code :You can install phpcs to check your code
+ * squizlabs/PHP_CodeSniffer to lint and follow PSR1/PSR2 rules. 
+ * friendsofphp/php-cs-fixer to fix the code
+ 
+Lint with this command `vendor/bin/phpcs src -n --standard=PSR1,PSR2 --report=summary` to get a summary of errors.
+Fix with this command `vendor/bin/php-cs-fixer fix src --rules=@PSR1,@PSR2`
+
+## Javascript
+For Javascript the following packages has been used: 
+ `npm install prettier`
+ 
+To lint the code: `node bin-prettier.js assets/js/**`
+To fix it: `node bin-prettier.js assets/js/** --write`
 
-You can install phpcs to check your code, for this run `composer require squizlabs/PHP_CodeSniffer`. This project follows 
-PSR1/PSR2 rules. Run this command `vendor/bin/phpcs src -n --standard=PSR1,PSR2 --report=summary` to get a summary of
-errors 
+## IDE
 
-For PHP you should configure your IDE to follow Symfony code style (or anything else if you prefer) for PHP, and Airbnb or any other check style for Javascript.
-You can use `friendsofphp/php-cs-fixer` package to fix your PHP code and `prettier`for Javascript.
-We may add those packages to the current stack if it's something requested.   
+For PHP you should configure your IDE to follow PSR1/PSR2 code style (or anything else if you prefer). For JS you will
+have to install [prettier tool](https://prettier.io/docs/en/editors.html).
 
 ## todo
 
@@ -143,3 +154,4 @@ We may add those packages to the current stack if it's something requested.
 * ~~add db fixtures at init ! almost 40 books and some reviews (at least 3 for 5 1st books)~~ all sqlite fixtures is converted into the final db model
 * customize easyAdminBundle to add author/editor from Book and display those related infos on Book admin page (same for other author/editor entities and serie/reviews)
 * manage Entity orphanRemoval / CASCADE onDelete
+* find a good way to add a `pre-commit` hook that lint PHP and JS code, and run the PHP / JS tests

assets/js/app.js

@@ -1 +0,0 @@
-

assets/js/csrf_token.js

@@ -18,14 +18,15 @@ export default function getToken(loaderToActivate) {
             cache: 'no-cache',
         }
         fetch(uri, myInit)
-        // @todo manage http error
-            .then(res => res.json()).then(res => {
-            changeMeta(meta, res)
-            if (loaderToActivate) {
-                loaderToActivate.isLoading = false
-            }
-            resolve(res)
-        })
+            // @todo manage http error
+            .then(res => res.json())
+            .then(res => {
+                changeMeta(meta, res)
+                if (loaderToActivate) {
+                    loaderToActivate.isLoading = false
+                }
+                resolve(res)
+            })
     })
 }
 

assets/js/form/App.vue

@@ -5,18 +5,18 @@
 </template>
 
 <script>
-    export default {
-        name: 'app',
-    }
+export default {
+    name: 'app',
+}
 </script>
 
 <style>
-    #app {
-        font-family: 'Avenir', Helvetica, Arial, sans-serif;
-        -webkit-font-smoothing: antialiased;
-        -moz-osx-font-smoothing: grayscale;
-        text-align: center;
-        color: #2c3e50;
-        margin-top: 60px;
-    }
+#app {
+    font-family: 'Avenir', Helvetica, Arial, sans-serif;
+    -webkit-font-smoothing: antialiased;
+    -moz-osx-font-smoothing: grayscale;
+    text-align: center;
+    color: #2c3e50;
+    margin-top: 60px;
+}
 </style>

assets/js/form/app.js

@@ -6,7 +6,7 @@ import router from './router'
 import Quasar from 'quasar-framework'
 import Vuelidate from 'vuelidate'
 import VueApollo from 'vue-apollo'
-import {apolloProvider} from '../apollo'
+import { apolloProvider } from '../apollo'
 
 require('../../../node_modules/quasar-framework/dist/quasar.mat.css')
 // not sure that fonts are loaded finely

assets/js/form/components/Book.vue

@@ -5,21 +5,19 @@
 </template>
 
 <script>
-    import {
+import { QItemMain, QItemTile } from 'quasar-framework'
+
+export default {
+    name: 'Book',
+    components: {
         QItemMain,
         QItemTile,
-    } from 'quasar-framework'
-
-    export default {
-        name: 'Book',
-        components: {
-            QItemMain,
-            QItemTile,
-        },
-        props: ['book'],
-    }
+    },
+    props: ['book'],
+}
 </script>
 
 <!-- Add "scoped" attribute to limit CSS to this component only -->
 <style scoped>
+
 </style>