Merge pull request #2542 from PVautour/develop

Improvements to setup documentation

.envrc

@@ -0,0 +1 @@
+use nix

.gitignore

@@ -84,3 +84,5 @@ common/config/rush/pnpm-lock.yaml
 
 **/packages/geoview-core/types
 packages/geoview-core/public/docs/
+
+.direnv/

README.md

@@ -69,6 +69,8 @@ $ cd geoview
 $ npm install -g @microsoft/rush
 ```
 
+* Note: you can also use the included `shell.nix` to setup your dev environment if you are on Mac/Linux/WSL.
+
 ### Install dependencies
 
 It's always recommended to run the below command if you pull any changes.

common/config/rush/command-line.json

@@ -7,12 +7,6 @@
       "summary": "Serves the page locally with hot-reload.",
       "shellCommand": "npm run --prefix packages/geoview-core serve"
     },
-    {
-      "commandKind": "global",
-      "name": "serve:mac",
-      "summary": "Serves the page locally with hot-reload for Mac users",
-      "shellCommand": "npm run --prefix packages/geoview-core serveMac"
-    },
     {
       "commandKind": "global",
       "name": "host",
@@ -25,12 +19,6 @@
       "summary": "Build the packages and move them to the dist directory",
       "shellCommand": "npm run --prefix packages/geoview-core build"
     },
-    {
-      "commandKind": "global",
-      "name": "build:mac",
-      "summary": "Build the packages and move them to the dist directory",
-      "shellCommand": "npm run --prefix packages/geoview-core buildMac"
-    },
     {
       "commandKind": "bulk",
       "name": "build",

packages/geoview-core/package.json

@@ -31,18 +31,13 @@
   "scripts": {
     "serve": "npm run format && npm run fix && webpack serve --progress --color --config webpack.dev.js",
     "build": "npm run format && npm run fix && npm run doc && webpack --progress --color --config webpack.prod.js && npm run generate.d.ts",
-    "serveMac": "npm run formatMac && npm run fixMac && webpack serve --progress --color --config webpack.dev.js",
-    "buildMac": "npm run formatMac && npm run fixMac && npm run doc && webpack --progress --color --config webpack.prod.js && npm run generate.d.ts",
     "doc": "typedoc src/app.tsx --logLevel Error --out public/docs",
     "deploy": "gh-pages -d dist",
     "test": "jest",
     "update_test": "jest --updateSnapshot",
-    "format": "prettier --write ../geoview-**/src/**/*.{ts,tsx,js}",
-    "lint": "eslint ../geoview-**/src/**/*.{ts,tsx,js}",
-    "fix": "eslint ../geoview-**/src/**/*.{ts,tsx,js} --fix",
-    "formatMac": "prettier --write '../geoview-**/src/**/*.{ts,tsx,js}'",
-    "lintMac": "eslint '../geoview-**/src/**/*.{ts,tsx,js}'",
-    "fixMac": "eslint '../geoview-**/src/**/*.{ts,tsx,js}' --fix",
+    "format": "prettier --write \"../geoview-**/src/**/*.{ts,tsx,js}\"",
+    "lint": "eslint \"../geoview-**/src/**/*.{ts,tsx,js}\"",
+    "fix": "eslint \"../geoview-**/src/**/*.{ts,tsx,js}\" --fix",
     "generate.d.ts": "tsc --noEmit false --skipLibCheck true --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "dependencies": {

packages/geoview-core/src/app.tsx

@@ -62,19 +62,19 @@ async function fetchConfigFile(configUrl: string): Promise<string> {
 
 /**
  * Function to get a configuration from a div element who contains attributes to read from.
- * If the div has one of the folllowing atttributes data-config, data-config-url or data-shared,
- * it will try to get a valide configuration from the attribute content. If there is no such attributes,
+ * If the div has one of the following atttributes data-config, data-config-url or data-shared,
+ * it will try to get a valid configuration from the attribute content. If there is no such attributes,
  * it will return a default config. If the data-geocore is present, it will inject the layer in the
- * consifuration automatically
+ * configuration automatically.
  *
  * @param {Element} mapElement - Div map element with attributes
- * @returns {Promise<TypeMapFeaturesConfig>} A promise who contains the caonfiguration to use
+ * @returns {Promise<TypeMapFeaturesConfig>} A promise that contains the configuration to use
  */
 async function getMapConfig(mapElement: Element): Promise<TypeMapFeaturesConfig> {
   // get language in wich we need to have the config file (if not provided, default to English)
+  const lang = mapElement.hasAttribute('data-lang') ? (mapElement.getAttribute('data-lang')! as TypeDisplayLanguage) : 'en';
 
   // create a new config object and apply default
-  const lang = mapElement.hasAttribute('data-lang') ? (mapElement.getAttribute('data-lang')! as TypeDisplayLanguage) : 'en';
   let mapConfig: MapFeatureConfig = api.config.getDefaultMapFeatureConfig(lang);
 
   // check what type of config is provided (data-config, data-config-url or data-shared)

shell.nix

@@ -0,0 +1,14 @@
+{
+  pkgs ? import <nixpkgs> { },
+}:
+
+pkgs.mkShell {
+  buildInputs = [
+    pkgs.nodejs
+    pkgs.nodePackages.rush
+  ];
+
+  shellHook = ''
+    echo "Development environment ready. You can use 'rush' now."
+  '';
+}