Merge pull request #18869 from Expensify/tgolen-patch-3

[No QA] Add information about Prettier into our style guide
Expensify · May 16, 2023 · 5be0c13 · 5be0c13
2 parents b54b16a + 21f69f6
commit 5be0c13
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 93 deletions.
diff --git a/contributingGuides/STYLE.md b/contributingGuides/STYLE.md
@@ -4,94 +4,11 @@ For almost all of our code style rules, refer to the [Airbnb JavaScript Style Gu
 
 When writing ES6 or React code, please also refer to the [Airbnb React/JSX Style Guide](https://github.com/airbnb/javascript/tree/master/react).
 
-There are a few things that we have customized for our tastes which will take precedence over Airbnb's guide.
-
-## Functions
-  - Always wrap the function expression for immediately-invoked function expressions (IIFE) in parens:
-
-    ```javascript
-    // Bad
-    (function () {
-        console.log('Welcome to the Internet. Please follow me.');
-    }());
-
-    // Good
-    (function () {
-        console.log('Welcome to the Internet. Please follow me.');
-    })();
-    ```
-
-## Whitespace
-  - Use soft tabs set to 4 spaces.
-
-    ```javascript
-    // Bad
-    function () {
-    ∙∙const name;
-    }
-
-    // Bad
-    function () {
-    ∙const name;
-    }
-
-    // Good
-    function () {
-    ∙∙∙∙const name;
-    }
-    ```
-
-  - Place 1 space before the function keyword and the opening parent for anonymous functions. This does not count for named functions.
-
-    ```javascript
-    // Bad
-    function() {
-        ...
-    }
+We use Prettier to automatically style our code.
+- You can run Prettier to fix the style on all files with `npm run prettier`
+- You can run Prettier in watch mode to fix the styles when they are saved with `npm run prettier-watch`
 
-    // Bad
-    function getValue (element) {
-        ...
-    }
-
-    // Good
-    function∙() {
-        ...
-    }
-
-    // Good
-    function getValue(element) {
-        ...
-    }
-    ```
-
-  - Do not add spaces inside curly braces.
-
-    ```javascript
-    // Bad
-    const foo = { clark: 'kent' };
-
-    // Good
-    const foo = {clark: 'kent'};
-    ```
-  - Aligning tokens should be avoided as it rarely aids in readability and often
-  produces inconsistencies and larger diffs when updating the code.
-
-    ```javascript
-    // Good
-    const foo = {
-        foo: 'bar',
-        foobar: 'foobar',
-        foobarbaz: 'foobarbaz',
-    };
-
-    // Bad
-    const foo = {
-        foo      : 'bar',
-        foobar   : 'foobar',
-        foobarbaz: 'foobarbaz',
-    };
-    ```
+There are a few things that we have customized for our tastes which will take precedence over Airbnb's guide.
 
 ## Naming Conventions
 

diff --git a/package.json b/package.json
@@ -9,18 +9,18 @@
   "scripts": {
     "postinstall": "npx patch-package && cd desktop && npm install",
     "clean": "npx react-native clean-project-auto",
-    "android": "scripts/set-pusher-suffix.sh &&  concurrently \"npx react-native run-android --port=8083\" npm:prettier-watch",
-    "ios": "scripts/set-pusher-suffix.sh && concurrently \"npx react-native run-ios --port=8082\" npm:prettier-watch",
-    "ipad": " concurrently \"npx react-native run-ios --port=8082 --simulator=\"iPad Pro (12.9-inch) (4th generation)\"\" npm:prettier-watch",
-    "ipad-sm": " concurrently \"npx react-native run-ios --port=8082 --simulator=\"iPad Pro (9.7-inch)\"\" npm:prettier-watch",
+    "android": "scripts/set-pusher-suffix.sh && npx react-native run-android --port=8083",
+    "ios": "scripts/set-pusher-suffix.sh && npx react-native run-ios --port=8082",
+    "ipad": "concurrently \"npx react-native run-ios --port=8082 --simulator=\"iPad Pro (12.9-inch) (4th generation)\"\"",
+    "ipad-sm": "concurrently \"npx react-native run-ios --port=8082 --simulator=\"iPad Pro (9.7-inch)\"\"",
     "start": "npx react-native start",
-    "web": "scripts/set-pusher-suffix.sh && concurrently npm:web-proxy npm:web-server npm:prettier-watch",
+    "web": "scripts/set-pusher-suffix.sh && concurrently npm:web-proxy npm:web-server",
     "web-proxy": "node web/proxy.js",
     "web-server": "webpack-dev-server --open --config config/webpack/webpack.dev.js",
     "build": "webpack --config config/webpack/webpack.common.js --env envFile=.env.production",
     "build-staging": "webpack --config config/webpack/webpack.common.js --env envFile=.env.staging",
     "build-adhoc": "webpack --config config/webpack/webpack.common.js --env envFile=.env.adhoc",
-    "desktop": "scripts/set-pusher-suffix.sh &&  concurrently \"node desktop/start.js\" npm:prettier-watch",
+    "desktop": "scripts/set-pusher-suffix.sh && node desktop/start.js",
     "desktop-build": "scripts/build-desktop.sh production",
     "desktop-build-staging": "scripts/build-desktop.sh staging",
     "createDocsRoutes": "node .github/scripts/createDocsRoutes.js",