feat(quick-doc): setup quick-doc

incubateur-ademe · Dec 18, 2023 · cd8329d · cd8329d
1 parent 116aea2
commit cd8329d
Show file tree

Hide file tree

Showing 15 changed files with 2,626 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -76,6 +76,23 @@ https://beta.gouv.fr.
 
 ## Développement
 
+### Quick Doc
+
+Pour faciliter le développement, nous avons mis en place une documentation
+minimale basée sur [`@publicodes/react-ui`](https://publi.codes/docs/api/react-ui)
+et [Vite](https://vitejs.dev/).
+
+```bash
+yarn --cwd quick-doc
+yarn doc
+```
+
+> [!TIP]
+> Pour rapidement itérer sur le modèle, nous vous conseillons de lancer `yarn
+> doc` dans un terminal et d'exécuter `yarn compile:rules-watch:fr dans un
+> autre terminal pour recompiler le modèle à chaque modification. La
+> documentation sera automatiquement mise à jour à la fin de la compilation.
+
 ### CI
 
 Le projet utilise plusieurs GitHub Actions pour automatiser les tâches de

diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "compile:rules-watch": "nodemon -e \"publicodes js mjs\" --watch data/ --watch scripts/ scripts/rulesToJSON.mjs",
     "compile:rules-watch:fr": "nodemon -e \"publicodes js mjs\" --watch data/ --watch scripts/ scripts/rulesToJSON.mjs -t fr -o FR",
     "compile-watch": "yarn compile:rules-watch & nodemon -e publicodes --watch personas/ scripts/personasToJSON.js",
+    "doc": "yarn --cwd quick-doc run dev",
     "test:personas": "node tests/testPersonas.mjs",
     "test:optim": "node tests/testOptim.mjs",
     "translate": "node scripts/i18n/translate-rules.js && node scripts/i18n/translate-personas.js",

diff --git a/quick-doc/.eslintrc.cjs b/quick-doc/.eslintrc.cjs
@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}
diff --git a/quick-doc/.gitignore b/quick-doc/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/quick-doc/README.md b/quick-doc/README.md
@@ -0,0 +1,13 @@
+# NGC Quick Doc
+
+This is a minimal documentation based on
+[`@publicodes/react-ui`](https://publi.codes/docs/api/react-ui) and
+[Vite](https://vitejs.dev/) to help you to implement the model and have a quick
+feedback.
+
+## To start
+
+```bash
+yarn
+yarn dev
+```
diff --git a/quick-doc/index.html b/quick-doc/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Quick-doc - Nos Gestes Climat</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/quick-doc/package.json b/quick-doc/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "quick-doc",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "publicodes-react": "^1.0.0-beta.77",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-markdown": "^9.0.1",
+    "react-router-dom": "^6.21.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.43",
+    "@types/react-dom": "^18.2.17",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "@vitejs/plugin-react": "^4.2.1",
+    "eslint": "^8.55.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.5",
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8"
+  }
+}
diff --git a/quick-doc/src/App.css b/quick-doc/src/App.css
@@ -0,0 +1,4 @@
+#root {
+  margin: 0 auto;
+  width: 80%;
+}
diff --git a/quick-doc/src/App.tsx b/quick-doc/src/App.tsx
@@ -0,0 +1,63 @@
+import Engine from 'publicodes'
+import './App.css'
+import { RulePage } from 'publicodes-react'
+import {
+  Link,
+  Route,
+  useParams,
+  createBrowserRouter,
+  createRoutesFromElements,
+  RouterProvider
+} from 'react-router-dom'
+import { ComponentProps, useRef } from 'react'
+import ReactMardown from 'react-markdown'
+
+import rules from '../../public/co2-model.FR-lang.fr.json'
+
+let engine = new Engine()
+
+try {
+  engine = new Engine(rules as {})
+} catch (e) {
+  console.error('Error while loading model:')
+  console.error(e)
+}
+
+const baseUrl = process.env.NODE_ENV === 'development' ? '' : '/nosgestesclimat'
+
+const defaultRule = 'bilan'
+
+function Documentation() {
+  const url = useParams()['*']
+  const { current: renderers } = useRef({
+    Link,
+    Text: ({ children }) => <ReactMardown children={children} />
+  } as ComponentProps<typeof RulePage>['renderers'])
+
+  return (
+    <div>
+      <RulePage
+        documentationPath={`${baseUrl}`}
+        rulePath={!url || url === '' ? defaultRule : url}
+        engine={engine}
+        renderers={renderers}
+        language={'fr'}
+        npmPackage="nosgestesclimat"
+      />
+    </div>
+  )
+}
+
+const router = createBrowserRouter(
+  createRoutesFromElements(
+    <Route path={`${baseUrl}/*`} element={<Documentation />} />
+  )
+)
+
+export default function App() {
+  return (
+    <div className="App">
+      <RouterProvider router={router} />
+    </div>
+  )
+}
diff --git a/quick-doc/src/main.tsx b/quick-doc/src/main.tsx
@@ -0,0 +1,9 @@
+import React from 'react'
+import ReactDOM from 'react-dom/client'
+import App from './App.tsx'
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>
+)
diff --git a/quick-doc/src/vite-env.d.ts b/quick-doc/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/quick-doc/tsconfig.json b/quick-doc/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/quick-doc/tsconfig.node.json b/quick-doc/tsconfig.node.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/quick-doc/vite.config.ts b/quick-doc/vite.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite'
+import react from '@vitejs/plugin-react'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+})