Skip to content

Latest commit

 

History

History
401 lines (284 loc) · 14.1 KB

README.md

File metadata and controls

401 lines (284 loc) · 14.1 KB
Raw

Étapes de construction

Squelette applicatif

Utilisation de l'utilitaire create-react-app pour construire le squelette du projet :

npx create-react-app capitaine-flemme
cd capitaine-flemme
npm install

Initialisation du projet Git

git init

Mise en place des outils d'automatisation

Auto-formatage du code avec Prettier

npm install --save-dev prettier

Comme ça on du code nickel chez tout le monde utilisant le projet et pour tout un tas d'extensions (JS, JSX, CSS, SCSS, JSON, Markdown, YAML, GraphQL…).

On ajoute nos règle custom dans le package.json :

  "prettier": {
    "arrowParens": "always",
    "singleQuote": true,
    "trailingComma": "es5",
    "semi": false
  },

On souhaitera également rappliquer le formatage lors de la création de nos commits, des fois que l'éditeur ait manqé qqch ou qu'un fichier ait été mis à jour sans que nous l'ayons ouvert (exemple du package.json suite à un npm install …). Il faut donc appliquer le formattage Prettier uniquement sur les portions de code modifiées et stagées/prêtes à être commitées avec precise-commits.

npm install --save-dev precise-commits

Configuration VSCode

Pour que ça marche nickel dans VSCode, installer l'extension Prettier.

Puis on customise la configuration du projet (workspace settings)

  // Exclusions from the explorer
  "files.exclude": {
    "**/.git": true,
    "**/.DS_Store": true,
    "**/node_modules": true
  },
  // Prettier & ESLint
  "prettier.arrowParens": "always",
  "prettier.eslintIntegration": true,
  "prettier.singleQuote": true,
  "prettier.trailingComma": "es5",
  "prettier.semi": false,
  "editor.formatOnSave": true,
  "javascript.format.enable": false,

ESLint

Comme on adore ESLint et que la norme tend à aller vers StandardJS pour les règles, on installe tout ce qu'il faut pour que tout ça marche ensemble :

npm install --save-dev eslint eslint-plugin-import eslint-plugin-node eslint-plugin-prettier eslint-plugin-promise eslint-plugin-react eslint-plugin-standard eslint-config-standard eslint-config-prettier

On affine notre configuration pour charger tout ça dans package.json :

  "eslintConfig": {
    "extends": [
      "standard",
      "prettier",
      "plugin:react/recommended",
      "plugin:import/errors"
    ],
    "plugins": [
      "prettier",
      "react",
      "import"
    ],
    "parser": "babel-eslint",
    "rules": {
      "prettier/prettier": [
        "error",
        {
          "arrowParens": "always",
          "singleQuote": true,
          "trailingComma": "es5",
          "semi": false
        }
      ],
      "no-irregular-whitespace": 0
    },
    "env": {
      "browser": true,
      "commonjs": true,
      "es6": true,
      "jest": true,
      "node": true
    },
    "settings": {
      "import/resolver": {
        "node": {
          "paths": [
            "jest/"
          ]
        }
      }
    }
  },

Garantir le format des messages de commit

Un format de message de commit complet et pratique pour leur réutilisation via des scripts pour générer des changelog/release-notes est le conventional changelog. Pour garantir leur rédaction on peut avoir deux approches complémentaires :

  • proposer une aide à la saisie
  • valider la saisie a posteriori

Pour l'aide à la saisie on peut utiliser commitizen qui nous permettra de faire git cz au lieu de git commit pour afficher un wizard :

npm install --save-dev commitizen cz-conventional-changelog

On précise dans la configuration (package.json) qu'on veut utiliser le conventional-changelog :

  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  }

Ensuite on veut s'assurer que les messages saisis répondent bien aux critères du conventional-changelog (dans le cas des saisies manuelles). On utilise commit-lint à cet effet :

npm install --save-dev @commitlint/cli @commitlint/config-conventional

On doit également préciser dans le package.json qu'on utilise le conventional-changelog :

  "commitlint": {
    "extends": [
      "@commitlint/config-conventional"
    ]
  },

NB: Une alternative à git commitizen est également proposée : @commitlint/prompt-cli.

Attention, commit-lint n'est pas lancé automatiquement au moment de notre saisie, il faut compléter son chargement via l'utilitaire de hooks Git : Husky.

Nos petits scripts à nous

Lors du commit

Vérifications des contenus

On veut effectuer tout un tas de vérifications sur les fichiers stagés/prêts à être commités :

  • Reste-t-il des marqueurs de conflits  ?
  • A-t-on laissé des mots clés FIXME ou TODO ?
  • A-t-on laissé des console.log… dans nos fichiers JS ?

C'est le module npm git-precommit-checks qui se charge de tout ça.

Le chargement de la configuration se fait depuis le package.json ce qui la rend extensible :

"git-precommit-checks": {
  "display": {
    "notifications": true,
    "offending-content": true,
    "rules-summary": true,
    "short-stats": true,
    "verbose": false
  },
  "rules": [
    {
      "filter": "\\.js$",
      "nonBlocking": "true",
      "message": "🤫 Oula, aurais-tu oublié des `console.log` inopportuns ?",
      "regex": "console\\.log"
    },
    {
      "message": "😨 On dirait que tu as oublié des marqueurs de conflits",
      "regex": "/^[<>|=]{4,}/m"
    },
    {
      "message": "🤔 Aurais-tu oublié de finir des développement ?",
      "nonBlocking": "true",
      "regex": "(?:FIXME|TODO)"
    }
  ]
}

Chaque entrée du tableau rules définit une règle d'analyse : un motif décrit par une expression régulière est recherché sur le contenu "stagé", et un message est affiché en cas de succès.

Par défaut chaque règle est bloquante et interdira le commit si un motif est trouvé. Ceci peut être contourné en renseignant une clé nonBlocking à true.

Un filtre peut également être appliquer sur le nom de fichier : filter.

Seules les clés message et regex sont obligatoires.

Pour plus d'information sur la mise en place de ce module vous pouvez consulter sa documentation.

Optimisations

On a un peut triché ici car on a directement injecté les fichiers dans un répertoire git-hooks à la racine du projet. Peut-être changerons-nous cela prochainement pour rendre ces compléments génériques et installables.

NB : si vous souhaitez les réutiliser, notez que ces derniers doivent être exécutables (chmod +x git-hooks/**/*.js).

Le script pre-commit/optimize-svg.js utilise svgo pour optimiser les SVG au moment du commit.

Ceci permet un premier jet de nettoyage. Par exemple on pourrait vouloir garder les commentaires en mode dév mais les purger plus tard, au build.

Le chargement de la configuration se fait depuis le package.json :

"svgo": {
  "presets": ["pre-commit"],
  "enable": ["removeDesc"],
  "disable": ["cleanupAttrs"]
}

Des presets peuvent être utilisés (pour l'instant uniquement pre-commit).

D'autres configurations plus fines peuvent être utilisées indépendamment ou en compléments (chargées après les presets) grâce aux clés enable et disable liées aux options homonymes de la commande svgo.

Lors du push

On veut vérifier qu'on introduit par de régression de couverture de tests JS/Jest. Pour ça on va utiliser un module node qui met à jour les stats de couverture qu'on aura préalablement renseigné dans notre package.json.

En mettant ces valeurs à jour et en relançant les tests de Jest, ce dernier bloquera de lui même le process en cours (le push) pour indiquer que notre couverture à regressé.

On ajoute une surcouche d'appel via notre script git-hooks/pre-push.js qui ne lance cette analyse que lorsque des fichiers JS ont été modifiés et stagés.

npm install --save-dev jest-coverage-ratchet

Dans le package.json :

  "jest": {
    "coverageReporters": [
      "json-summary"
    ],
    "coverageThreshold": {
      "global": {
        "lines": 0,
        "statements": 0,
        "functions": 0,
        "branches": 0
      }
    }
  },

Husky

Husky permet de gérer les hooks Git depuis le package.json.

npm install --save-dev husky

On le configure alors pour lancer nos scripts de hooks ainsi que commit-lint et precise-commit (package.json) :

  "husky": {
    "hooks": {
      "commit-msg": "commitlint -e $GIT_PARAMS",
      "pre-commit": "git-precommit-checks && ./git-hooks/pre-commit/optimize-svg.js && precise-commits",
      "pre-push": "./git-hooks/pre-push.js"
    }
  },

NB : d'autres hooks sont disponibles.

Tests automatisés d'accessibilité ♿️

Dans notre éditeur

Un super plugin ESLint permet de faire de l'analyse statique sur du JSX. Donc pour notre appli React c'est top. Reste à l'installer : npm install --save-dev eslint-plugin-jsx-a11y.

Puis dans notre package.json, on ajoute la conf :

  "eslintConfig": {
    "extends": [
      …
      "plugin:jsx-a11y/recommended"
    ],
    "plugins": [
      …
      "jsx-a11y"
    ],
    …
  }

En appui de nos tests automatisés

Bon là on ne promet pas de miracles, mais déjà quelques vérifications de base. Comme la plupart des scripts on pourra préférer intégrer ça au niveau de la CI plutôt que côté dev en pre-push. Mais comme ici on veut blinder le travail partagé avant envoi, on fera ça côté machine de dév, même si ça bouffe de la ressource.

Disclaimer : la suite de cette section suit une prodécure décrite par des gens biens chez Marmelab

Pour tester l'accessibilité, il faut simuler l'affichage. Pour ça on a un truc génial, du chrome headless (depuis la v59) avec son API (les dev-tools) pour intéragir avec : puppeteer.

Nos tests eux sont écrits et lancés avec Jest, on va donc avoir besoin d'une passerelle, et coup de bol, 'y'en a une toute faite : jest-puppeteer.

Côté tests automatisés de l'accessibilité, on va utiliser axe-core.

On aura besoin d'un serveur pour tout ça.

npm install --save-dev axe-core jest-puppeteer puppeteer serve babel-preset-env react-scripts@next.

Notez la présence de babel-preset-env pour nous permettre d'utiliser les dernières syntaxes ES6, notamment async/await. On complète avec le fichier accessibility/.babelrc :

{
  "presets": ["env"]
}

On est également obligé de tricher pour utiliser la dernière version de react-scripts qui permettra de faire fonctionner tout ça.

Rq : selon le gouvernement anglais, l'automatisation des tests d'accessibilité ne permet de couvrir que 30% des problématiques. Soyez donc vigilants et allez au bout de vos démarches en ajoutant des tests via les technologies d'assistance (lecteurs d’écrans etc.) et incluez si possible des utilisateurs en situation de handicap pour des tests en situation.

Mise en place de l'Auto DevOps de GitLab

Dans notre projet GitLab fraichement créé nous devons activer l'auto DevOps. Comme tout ceci est encore à ses premisses il nous faut gérer quelques détails parfois mal documentés :

Cluster Kubernetes

Créer un ou plusieurs clusters Kubernetes (depuis Google Kubernetes Enginee, alias GKE).

Domaine

Pour ne pas se galérer dans l'immédiat avec un domaine custom, on va passer par nip.io. Mais pour que ça marche bien avec GitLab il faut activer Ingress qui va s'auto-câler sur notre cluster. De ce fait on aura plus qu'à copier/coller ce qui nous sera proposé dans la partie Settings > CI/CD > Auto DevOps pour le domaine.

Et ensuite ?

Là ça commence à devenir plaisant. Si on créé une pull request on, GitLab va automatiquement déclencher tout un tas de choses avec sa pipeline après avoir fait de l'auto-détection de stack technique.

Autres ressources utiles

VSCode

Site officiel : https://code.visualstudio.com

Astuces et plugins par Delicious-Insights : https://installations.delicious-insights.com/software/vscode.html

Lint

Article intéressant sur ESLint : https://dev.to/lauragift21/quick-guide-to-linting-javascript-codebase-with-eslint-dcf

Pour linter les fichiers stagés :

Formatage

https://prettier.io/ : pour le JS/TS, CSS, Less, Scss, Vue, JSON, GraphQL, Markdown, JSX, Flow, et d'autres à venir…

Accessibilité

Outil de test auto pour l'accessibilité (gérera uniquement les défauts communs en auto, ne remplacera pas des tests d'interface).

https://github.com/nickcolley/jest-axe

Automatisation des tests d'accessibilité :

Les hooks git

Changelog

Automatiser la génération du changelog :

En vrac :