[TEAMMATES#7433] Add lintspaces to enforce space-related rules (TEAMMATES#7434)

Author: wkurniawan07

LICENSE

@@ -336,4 +336,4 @@ This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
 library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.
+Public License instead of this License.

appveyor.yml

@@ -24,7 +24,7 @@ install:
   - npm install
 
 build_script:
-  - gradlew.bat createConfigs testClasses 
+  - gradlew.bat createConfigs testClasses
 
 test_script:
   - npm run build

docs/design.md

@@ -125,7 +125,7 @@ Represented by these classes:
 
 ### Policies
 
-General: 
+General:
 + Null values should **not** be used as parameters to this API, except when following the KeepExisting policy (explained later).
 
 Access control:
@@ -139,7 +139,7 @@ API for creating entities:
 
 API for retrieving entities:
 + Attempting to retrieve objects using `null` parameters: Causes an assertion failure.
-+ Entity not found: 
++ Entity not found:
   - Returns `null` if the target entity not found. This way, read operations can be used easily for checking the existence of an entity.
   - Throws `EntityDoesNotExistsExeption` if a parent entity of a target entity is not found e.g., trying to list students of a non-existent course.
 
@@ -153,7 +153,7 @@ API for updating entities:
 API for deleting entities:
 + `Null` parameters: Not expected. Results in assertion failure.
 + FailDeleteSilentlyPolicy: In general, delete operation do not throw exceptions if the target entity does not exist. Instead, it logs a warning. This is because if it does not exist, it is as good as deleted.
-+ Cascade policy:   When a parent entity is deleted, entities that have referential integrity with the deleted entity should also be deleted.  
++ Cascade policy:   When a parent entity is deleted, entities that have referential integrity with the deleted entity should also be deleted.
   Refer to the API for the cascade logic.
 
 ## Storage Component
@@ -187,12 +187,12 @@ Represented by the `*Db` classes. These classes act as the bridge to the GAE Dat
 
 ### Policies
 
-Add and Delete operations try to wait until data is persisted in the datastore before returning. This is not enough to compensate for eventual consistency involving multiple servers in the GAE production enviornment. However, it is expected to avoid test failures caused by eventual consistency in dev server and reduce such problems in the live server. 
-Note: 'Eventual consistency' here means it takes some time for a database operation to propagate across all serves of the Google's distributed datastore. As a result, the data may be in an inconsistent states for short periods of time although things should become consistent 'eventually'. For example, an object we deleted may appear to still exist for a short while. 
+Add and Delete operations try to wait until data is persisted in the datastore before returning. This is not enough to compensate for eventual consistency involving multiple servers in the GAE production enviornment. However, it is expected to avoid test failures caused by eventual consistency in dev server and reduce such problems in the live server.
+Note: 'Eventual consistency' here means it takes some time for a database operation to propagate across all serves of the Google's distributed datastore. As a result, the data may be in an inconsistent states for short periods of time although things should become consistent 'eventually'. For example, an object we deleted may appear to still exist for a short while.
 
-Implementation of Transaction Control has been decided against due to limitations of GAE environment and the nature of our data schema. Please see [TEAMMATES Decision Analysis](https://docs.google.com/document/pub?id=1o6pNPshCp9S31ymHY0beQ1DVafDa1_k_k7bpxZo5GeU&embedded=true) document for more information. 
+Implementation of Transaction Control has been decided against due to limitations of GAE environment and the nature of our data schema. Please see [TEAMMATES Decision Analysis](https://docs.google.com/document/pub?id=1o6pNPshCp9S31ymHY0beQ1DVafDa1_k_k7bpxZo5GeU&embedded=true) document for more information.
 
-General: 
+General:
 + If `Null` is passed as a parameter, the corresponding value is **NOT** modified, as per the KeepExistingPolicy that was previously mentioned.
 
 API for creating:

docs/godmode.md

@@ -6,23 +6,20 @@ Typically browser tests involve comparing the source of the webpage to an existi
 
 GodMode has been extended and now is also able to create and update *expected* source files for email content tests. It works with the same underlying principle as the one for browser tests.
 
-
 ## How does GodMode work?
 
 The essential idea is to reverse the process of testing. We use the _actual_ source of the webpage to overwrite the _expected_ source in the test. To remove redundancy, even if GodMode is enabled, this overwriting procedure only happens when a test fails during the test run. Finally before the changes are committed, a *manual* (by the developer) verification to ensure only the intended changes have occurred is mandatory.
 
-
 ## How do we use GodMode?
 
-GodMode can be activated in two different ways. 
+GodMode can be activated in two different ways.
 
 1. If we want to execute arbitrary tests using GodMode, then update `BaseUiTestCase` class (or `EmailGeneratorTest` class if testing email content) and set `isGodModeEnabled = true` at the top of the class implementation. Now all test runs would have GodMode enabled. Please remember to set it back to false when done.
 
 2. If we want to run a particular test suite using GodMode, then go to `Run -> Run Configurations` and update the appropriate one with the `-Dgodmode=true` VM argument. Please remember to remove the argument before committing the changes
 
 Note: The first option encompasses the functionality of the second. By updating the BaseUiTestCase and running the intended test suite, we achieve the second option's effect.
 
-
 ## When do we use GodMode?
 
 GodMode is typically used in the following two situations:
@@ -38,7 +35,7 @@ studentHomePage.verifyHtmlMainContent("/studentHomeTypicalHTML.html");
 
 Here are three possible situations and the corresponding behaviours of GodMode when the test is executed with GodMode enabled:
 
-1. If `studentHomeTypicalHTML.html` exists and has the correct content, GodMode will not make any updates to the source file. 
+1. If `studentHomeTypicalHTML.html` exists and has the correct content, GodMode will not make any updates to the source file.
 
 2. If `studentHomeTypicalHTML.html` exists but has the wrong content, GodMode will update the source file with the correct content. The effect of this is that the test case will pass subsequent test runs with/without GodMode enabled.
 
@@ -49,7 +46,6 @@ The same idea applies to email content test:
 EmailChecker.verifyEmailContent(email, recipient, subject, "/studentCourseJoinEmail.html");
 ```
 
-
 ## Best Practices
 
 1. Ensure that GodMode is only used when necessary, that is when there are new test cases being created or when an update to the existing tests is foreseen.
@@ -58,8 +54,7 @@ EmailChecker.verifyEmailContent(email, recipient, subject, "/studentCourseJoinEm
 
 3. Please confirm that all the changes made by GodMode are EXPECTED. If any unexpected changes are made, please ask for assistance in the issue tracker or create a new issue if need be.
 
-4. After all the necessary changes have been made, run the test suite once without GodMode enabled to ensure that the tests pass without GodMode. 
-
+4. After all the necessary changes have been made, run the test suite once without GodMode enabled to ensure that the tests pass without GodMode.
 
 ## Final Notes
 
@@ -87,4 +82,4 @@ to
 </div>
 ```
 
-Happy Testing!
+Happy Testing!

docs/ide-usage.md

@@ -71,7 +71,7 @@ The following plugins are needed:
      * HTML: `Web → HTML Files → Editor → Indent using spaces`.
      * CSS: `Web → CSS Files → Editor → Indent using spaces`.
      * XML: `XML → XML Files → Editor → Indent using spaces`.
-   * Validation: 
+   * Validation:
      * We do not validate HTML, JSP, and XML. `Validation` → uncheck the `Build` option for `HTML Syntax Validator`, `JSP Content Validator`, `JSP Syntax Validator`, and `XML Validator`.
      * Disable JavaScript validation for `node_modules` folder. `Validation` → click the `...` settings button for `JavaScript Validation` → if `Exclude Group` is not already in the list then click `Add Exclude Group...` → `Exclude Group` → `Add Rule...` → `Folder or file name` → `Next` → `Browse Folder...` → navigate to the `node_modules` folder and confirm → `Finish`.
 

docs/settingUp.md

@@ -43,9 +43,9 @@ More information can be found at [this documentation](https://help.github.com/ar
 1. Run this command to download the correct version Google App Engine SDK as used in the project:
    ```sh
    ./gradlew appengineDownloadSdk
-   ```  
+   ```
    **Verification:** Check your Gradle folder (the directory can be found with the command `./gradlew printUserHomeDir`). A folder named appengine-sdk` should be present.
- 
+
 1. Run this command to download the necessary tools for JavaScript development:
    ```sh
    npm install

docs/troubleshooting-guide.md

@@ -20,7 +20,7 @@ Note that some of the screenshots might be outdated, but the instructions will r
   **REASON**: This happens because Eclipse is only aware of JRE, not JDK (Compiling JSP requires the JDK).
 
   Go to `Window → Preferences → Java → Installed JREs`. You will note that a JRE path is the one selected, not a JDK path.
-  
+
   **SOLUTION**: To fix this, Click `Add → Standard VM`, then for the JRE Path enter the path of the JRE folder inside your JDK installation folder, e.g. `C:/jdk1.7/jre`. Now you should see all of the JARs added to the library section.
 
 * **ERROR**: When trying to deploy, Eclipse complains "... Cannot get the System Java Compiler. Please use a JDK, not a JRE.".
@@ -106,7 +106,7 @@ Furthermore, you might see tags such as `${test.student1}` and `${version}` in s
 * **ERROR**: After deploying on the staging server, you get an error related to "Unsupported major.minor version ..." when trying to access pages of the staged app.
 
   **REASON**: This can happen if you have Java 8 installed and Eclipse uses Java 8 during deployment, even if you have already configured the project to use Java 7.
-   
+
   **SOLUTION**: Refer to [this page](http://java.wildstartech.com/Java-Platform-Standard-Edition/mac-os-x-java-development/how-to-configure-eclipse-to-run-with-java-7-when-java-8-is-installed) to learn how to modify `eclipse.ini` to use Java 7 by default.
 
 * **ERROR**: A handful of failed test cases (< 10).
@@ -140,9 +140,9 @@ Furthermore, you might see tags such as `${test.student1}` and `${version}` in s
    **SOLUTION**: Add `-Djava.io.tmpdir=/path/to/teammates/tmp` for the tests' run configurations. The "tmp" folder in the specified directory needs to be created before running the tests.
 
 * **ERROR (on IntelliJ)**: Error message in console when running dev server : `Cannot start process, the working directory '{project home directory}/build/libs/exploded/teammates.war' does not exist` or `Could not locate /.../appengine-web.xml`.
-   
+
   **SOLUTION**: The path to the exploded application may be configured wrongly. Go to `File → Project Structure...`. Under `Under Artifacts → Gradle : <your-project-name>.war (exploded)`, change `Output directory` to `{path to repo}/build/exploded-app`, which contains `appengine-web.xml`.
-   
+
 ## Submitting help request
 
 If none of the items in this guide helps with the problem you face, you can [post in the issue tracker](https://github.com/TEAMMATES/teammates/issues/new) to request for help.

package.json

@@ -6,6 +6,7 @@
     "eslint-config-airbnb-base": "11.1.1",
     "eslint-plugin-import": "2.2.0",
     "eslint-plugin-json": "1.2.0",
+    "lintspaces-cli": "0.6.0",
     "stylelint": "7.9.0"
   },
   "babel": {
@@ -25,6 +26,7 @@
     "lint:test": "eslint src/main/webapp/dev -c static-analysis/teammates-eslint.yml --ext .es6",
     "lint:json": "eslint src/main/webapp/js/*.json src/main/resources/*.json src/test/resources/data/*.json -c static-analysis/teammates-eslint-json.yml",
     "lint:css": "stylelint src/main/webapp/stylesheets/*.css --config static-analysis/teammates-stylelint.yml",
-    "lint": "npm run lint:src && npm run lint:test && npm run lint:json && npm run lint:css"
+    "lint:spaces": "lintspaces -n -t -d spaces -l 1 -. 'src/**/*.jsp' 'src/**/*.tag' 'src/main/**/*.html' 'src/**/*.xml' 'src/**/*.json' 'src/**/*.css' 'src/**/*.java' 'src/**/*.es6' 'src/**/*.properties' '*.yml' '*.gradle' 'static-analysis/*.*ml'",
+    "lint": "npm run lint:src && npm run lint:test && npm run lint:json && npm run lint:css && npm run lint:spaces"
   }
 }

src/client/java/teammates/client/scripts/scalabilitytests/InstructorCourseEnrollPageDataGenerator.java

@@ -9,7 +9,6 @@
 
 import teammates.test.driver.FileHelper;
 
-
 /**
  * Generates test data for InstructorCourseEnrollPageScaleTest.
  */

src/main/java/teammates/common/util/StringHelper.java

@@ -555,7 +555,6 @@ public static String removeNonAscii(String text) {
         return text.replaceAll("[^\\x00-\\x7F]", "");
     }
 
-
     /**
      * Returns a new String composed of copies of the String elements joined together
      * with a copy of the specified delimiter.

src/main/java/teammates/ui/automated/FeedbackResponseAdjustmentWorkerAction.java

@@ -15,7 +15,6 @@
 import teammates.common.util.LogMessageGenerator;
 import teammates.common.util.Logger;
 
-
 /**
  * Task queue worker action: adjusts feedback responses in the database due to
  * change in student enrollment details of a course.

src/main/resources/InstructorSampleData.json

@@ -2783,4 +2783,4 @@
     }
   },
   "profiles": {}
-}
+}

src/main/resources/META-INF/persistence.xml

@@ -11,4 +11,4 @@
         </properties>
     </persistence-unit>
 
-</persistence>
+</persistence>

src/main/resources/build.template.properties

@@ -1,12 +1,12 @@
 #-----------------------------------------------------------------------------
 # This file contains some configuration values required using building
 #   and running of the app.
-# It should be placed in src\main\resources 
+# It should be placed in src\main\resources
 # Use '\' to escape ':' e.g., http\://google.com
 #-----------------------------------------------------------------------------
 
 # This is the app url used in emails sent out by app.
-# For dev server, any URL would do. 
+# For dev server, any URL would do.
 # For staging server, use the url of the app on remote server.
 # e.g. app.url=https\://teammates-john.appspot.com
 app.url=https\://teammates-john.appspot.com
@@ -17,9 +17,9 @@ app.url=https\://teammates-john.appspot.com
 # e.g. app.gcs.bucketname = teammates-michelle.appspot.com
 app.gcs.bucketname=teammates-john.appspot.com
 
-# This is the key used by test driver to access backdoor. 
-# It can be any random string you choose, 
-#   as long as it matches with test.backdoor.key in test.properties. 
+# This is the key used by test driver to access backdoor.
+# It can be any random string you choose,
+#   as long as it matches with test.backdoor.key in test.properties.
 # e.g. app.backdoor.key=lsfdieafoereojfe
 
 app.backdoor.key=samplekey
@@ -33,12 +33,12 @@ app.encryption.key=5360b12f6a07af7be93437d215f72fca
 # This is the maximum time the app waits for a datastore operation to persist.
 # We use such a delay because of 'eventual consistency' nature of the datastore.
 # Increase the number if test cases fail due to persistency delays.
-# Value is in milliseconds 
+# Value is in milliseconds
 app.persistence.checkduration=4000
 
 # This is the email address to report runtime error not handled
 #   by the system, i.e. AssertionFailure and other unchecked exceptions.
-# This should be an email you check. e.g., email of the app admin.  
+# This should be an email you check. e.g., email of the app admin.
 app.crashreport.email = app_admin@gmail.com
 
 # This is the url to display as a message of the day to a student.
@@ -66,17 +66,16 @@ app.email.replyto = teammates@comp.nus.edu.sg
 app.email.service = javamail
 
 # Sendgrid API key for sending emails
-app.sendgrid.apikey = 
+app.sendgrid.apikey =
 
 # Mailgun API key for sending emails
-app.mailgun.apikey = 
+app.mailgun.apikey =
 
 # Mailgun domain name for sending emails
-app.mailgun.domainname = 
+app.mailgun.domainname =
 
 # Mailjet API key for sending emails
-app.mailjet.apikey = 
+app.mailjet.apikey =
 
 # Mailjet secret key for sending emails
-app.mailjet.secretkey = 
-
+app.mailjet.secretkey =

src/main/resources/feedbackQuestionAdditionalInfoTemplate.html

@@ -2,4 +2,4 @@
     <a href="javascript:;" id="questionAdditionalInfoButton-${questionNumber}-${additionalInfoId}" class="color_gray" onclick="toggleAdditionalQuestionInfo('${questionNumber}-${additionalInfoId}')" data-more="${more}" data-less="${less}">${more}</a>
     <br>
     <span id="questionAdditionalInfo-${questionNumber}-${additionalInfoId}" style="display:none;">${questionAdditionalInfo}</span>
-</span>
+</span>

src/main/resources/feedbackQuestionConstSumEditFormOptionFragment.html

@@ -5,12 +5,12 @@
                 id="${Const.ParamsNames.FEEDBACK_QUESTION_CONSTSUMOPTION}-${i}-${questionNumber}"
                 class="constSumOptionTextBox" value="${constSumOptionValue}">
         <span class="input-group-btn">
-            <button class="btn btn-default removeOptionLink" type="button" id="constSumRemoveOptionLink" 
+            <button class="btn btn-default removeOptionLink" type="button" id="constSumRemoveOptionLink"
                     onclick="removeConstSumOption(${i},${questionNumber})"
                     style="display:none" tabindex="-1">
                 <span class="glyphicon glyphicon-remove">
                 </span>
             </button>
         </span>
     </div>
-</div>
+</div>

src/main/resources/feedbackQuestionConstSumResultStatsOptionFragment.html

@@ -6,9 +6,9 @@
         ${pointsReceived}
     </td>
     <td>
-    	${totalPoints}
+        ${totalPoints}
     </td>
     <td>
         ${averagePoints}
     </td>
-</tr>
+</tr>

src/main/resources/feedbackQuestionConstSumResultStatsRecipientFragment.html

@@ -9,9 +9,9 @@
         ${pointsReceived}
     </td>
     <td>
-    	${totalPoints}
+        ${totalPoints}
     </td>
     <td>
         ${averagePoints}
     </td>
-</tr>
+</tr>

src/main/resources/feedbackQuestionConstSumResultStatsRecipientTemplate.html

@@ -29,4 +29,4 @@
             </table>
         </div>
     </div>
-</div>
+</div>

src/main/resources/feedbackQuestionConstSumResultStatsTemplate.html

@@ -35,4 +35,4 @@
             </table>
         </div>
     </div>
-</div>
+</div>

src/main/resources/feedbackQuestionContribAdditionalInfoTemplate.html

@@ -2,4 +2,4 @@
     <a href="javascript:;" id="questionAdditionalInfoButton-${questionNumber}-${additionalInfoId}" class="small link-in-dark-bg" onclick="toggleAdditionalQuestionInfo('${questionNumber}-${additionalInfoId}')" data-more="${more}" data-less="${less}">${more}</a>
     <br>
     <span id="questionAdditionalInfo-${questionNumber}-${additionalInfoId}" style="display:none;">${questionAdditionalInfo}</span>
-</span>
+</span>

src/main/resources/feedbackQuestionContribEditFormTemplate.html

@@ -6,4 +6,4 @@
             <span style="margin-left: 5px; font-weight: bold;">Allow response giver to select 'Not Sure' as the answer</span>
         </div>
     </div>
-</div>
+</div>

src/main/resources/feedbackQuestionContribResultStatsFragment.html

@@ -1,10 +1,10 @@
 <tr>
     <td>${studentTeam}</td>
-    <td id="${Const.ParamsNames.STUDENT_NAME}"> 
+    <td id="${Const.ParamsNames.STUDENT_NAME}">
         ${studentName}
     </td>
     <td>${CC}</td>
     <td>${PC}</td>
     <td>${Diff}</td>
     <td>${RR}</td>
-</tr>
+</tr>