Set up Prettier for reformatting if documentation and config files

Author: thibaudcolas

.editorconfig

@@ -11,11 +11,11 @@ end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
-indent_size = 4
+indent_size = 2
 max_line_length = 80
 
-[*.yml]
-indent_size = 2
+[*.{py,pyi}]
+indent_size = 4
 
 # Documentation.
 [*.md]

.githooks/pre-commit

@@ -6,22 +6,57 @@ set -e
 # Check if this is the initial commit
 if git rev-parse --verify HEAD >/dev/null 2>&1
 then
-    against=HEAD
+  against=HEAD
 else
-    against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+  against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
 fi
 
 # Use git diff-index to check for whitespace errors
-if ! git diff-index --check --cached $against
+if ! git diff-index --check --cached $against -- ':!*.snap' .
 then
-    echo "Aborting commit due to whitespace errors."
-    exit 1
+  echo "Aborting commit due to whitespace errors."
+  exit 1
 fi
 
 NEW_FILES=$(git --no-pager diff --name-only --cached --diff-filter=ACM)
 PY_FILES=$(echo "$NEW_FILES" | { grep .py || true; })
 
-if [ -n "$PY_FILES" ];
+# Only keep staged files that are added (A), copied (C) or modified (M).
+STAGED=$(git --no-pager diff --name-only --cached --diff-filter=ACM)
+# Files which are only partly staged (eg. git add --patch).
+PATCH_STAGED=$(git --no-pager diff --name-only --diff-filter=ACM $STAGED)
+# Files which are fully staged.
+FULLY_STAGED=$(comm -23 <(echo "$STAGED") <(echo "$PATCH_STAGED"))
+
+PRETTIER_STAGED=$(grep -E '.(md|css|scss|js|json|json5|yaml|yml|html)$' <<< "$STAGED" || true)
+PRETTIER_FULLY_STAGED=$(grep -E '.(md|css|scss|js|json|json5|yaml|yml|html)$' <<< "$FULLY_STAGED" || true)
+PY_STAGED=$(grep .py$ <<< "$STAGED" || true)
+PY_FULLY_STAGED=$(grep .py$ <<< "$FULLY_STAGED" || true)
+
+# Uncomment, and add more variables to the list, for debugging help.
+# tr ' ' '\n' <<< "STAGED $STAGED PATCH_STAGED $PATCH_STAGED FULLY_STAGED $FULLY_STAGED JS_STAGED $JS_STAGED
+
+# Format and re-stage fully staged files only.
+
+if [ -n "$PRETTIER_FULLY_STAGED" ];
+then
+  npx prettier --write $PRETTIER_FULLY_STAGED
+  git add $PRETTIER_FULLY_STAGED
+fi
+
+if [ -n "$PRETTIER_STAGED" ];
+then
+  npx prettier --check $PRETTIER_STAGED
+fi
+
+if [ -n "$PY_FULLY_STAGED" ];
+then
+  black $PY_FULLY_STAGED
+  git add $PY_FULLY_STAGED
+fi
+
+if [ -n "$PY_STAGED" ];
 then
-    make test-ci
+	black --check $PY_STAGED
+  make test-ci
 fi

.nvmrc

@@ -0,0 +1 @@
+14

.prettierignore

@@ -0,0 +1,8 @@
+node_modules
+.tox
+.venv
+coverage_html_report
+.pytest_cache
+.mypy_cache
+example.html
+example.md

.travis.yml

@@ -5,26 +5,31 @@ language: python
 cache:
   pip: true
   directories:
-  - .tox
+    - .tox
 jobs:
   include:
-  - env: TOXENV=py36-lower_bound_deps
-    python: 3.6
-  - env: TOXENV=py37-lower_bound_deps
-    python: 3.7
-  - env: TOXENV=py38-lower_bound_deps
-    python: 3.8
-  - env: TOXENV=py36-upper_bound_deps
-    python: 3.6
-  - env: TOXENV=py37-upper_bound_deps
-    python: 3.7
-  - env: TOXENV=py38-upper_bound_deps
-    python: 3.8
+    - env: TOXENV=py36-lower_bound_deps
+      python: 3.6
+    - env: TOXENV=py37-lower_bound_deps
+      python: 3.7
+    - env: TOXENV=py38-lower_bound_deps
+      python: 3.8
+    - env: TOXENV=py36-upper_bound_deps
+      python: 3.6
+    - env: TOXENV=py37-upper_bound_deps
+      python: 3.7
+    - env: TOXENV=py38-upper_bound_deps
+      python: 3.8
+    - language: node_js
+      install:
+        - npm install --no-optional --no-audit --progress=false
+      script:
+        - npm run lint
 install:
-- pip install tox coveralls==1.10.0
+  - pip install tox coveralls==1.10.0
 script:
-- make test-ci
+  - make test-ci
 after_success:
-- coveralls
+  - coveralls
 notifications:
   email: false

Makefile

@@ -17,6 +17,7 @@ lint: ## Lint the project.
 format: ## Format project files.
 	isort --recursive *.py **/*.py
 	black **/*.py
+	npm run format
 
 test: ## Test the project.
 	python -m unittest discover

package-lock.json

@@ -0,0 +1,14 @@
+{
+  "name": "draftjs_exporter",
+  "version": "0.0.0-dev",
+  "private": true,
+  "description": "Library to convert rich text from Draft.js raw ContentState to HTML",
+  "license": "MIT",
+  "devDependencies": {
+    "prettier": "2.0.5"
+  },
+  "scripts": {
+    "lint": "prettier --check '**/?(.)*.{md,css,scss,js,json,json5,yaml,yml,html}'",
+    "format": "prettier --write '**/?(.)*.{md,css,scss,js,json,json5,yaml,yml,html}'"
+  }
+}

package.json

@@ -0,0 +1,13 @@
+// See https://prettier.io/docs/en/options.html.
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: false,
+  trailingComma: "all",
+  bracketSpacing: true,
+  jsxBracketSameLine: false,
+  arrowParens: "always",
+  proseWrap: "preserve",
+};