@abi-software/flatmapvuer 1.17.1-demo.0 → 1.18.0

package/README.md

@@ -10,18 +10,23 @@ This project is now built with Vue3 frameworks, Vue 2 version of Flatmapvuer is
 ## Flatmapvuer on NPM
 
 Flatmapvuer is available on npm and can be installed into your project with the following command:
+
 ```bash
 npm i @abi-software/flatmapvuer
 ```
 
 ## How to use
+
 Install the package "npm i @abi-software/flatmapvuer" to your vue app.
 Include the package in your script.
+
 ```javascript
-import {FlatmapVuer, MultiFlatmapVuer} from '@abi-software/flatmapvuer';
+import { FlatmapVuer, MultiFlatmapVuer } from '@abi-software/flatmapvuer';
 import '@abi-software/flatmapvuer/dist/style.css';
 ```
+
 Local registration in vue component:
+
 ```javascript
 export default {
   ...
@@ -35,8 +40,14 @@ export default {
 
 The line above registers both the FlatmapVuer and MultiFlatmapVuer component into the global scope.
 You can now use the FlatmapVuer in your vue template as followed:
+
 ```html
-<FlatmapVuer entry="NCBITaxon:9606" uuid="uuid-to-set" v-on:resource-selected="FlatmapSelected"  v-on:ready="FlatmapReady"/>
+<FlatmapVuer
+  entry="NCBITaxon:9606"
+  uuid="uuid-to-set"
+  v-on:resource-selected="FlatmapSelected"
+  v-on:ready="FlatmapReady"
+/>
 ```
 
 **entry** is the variable/string with the NCBI Taxonomy term. Some of the available taxon including: NCBITaxon:9606 (Human), NCBITaxon:9685 (Cat), NCBITaxon:9823 (Pig), NCBITaxon:10090 (Mouse) and NCBITaxon:10114 (Rat). This will always get the latest version of a map with the matching taxon.
@@ -65,12 +76,18 @@ Please see the following sample codes for details.
 ```
 
 You can also use MultiFlatmapVuer to provide a selection of flatmaps.
+
 ```html
-<MultiFlatmapVuer :availableSpecies="availableSpecies"
+<MultiFlatmapVuer
+  :availableSpecies="availableSpecies"
   @resource-selected="FlatmapSelected"
-  @ready="FlatmapReady" :initial="initial"/>
+  @ready="FlatmapReady"
+  :initial="initial"
+/>
 ```
+
 **availableSpecies** is the object containing information of available species for the users. See below for an example:
+
 ```javascript
   availableSpecies : {
     "Human":{taxo: "NCBITaxon:9606", iconClass:"icon-mapicon_human"},
@@ -80,42 +97,47 @@ You can also use MultiFlatmapVuer to provide a selection of flatmaps.
     "Cat":{taxo: "NCBITaxon:9685", iconClass:"icon-mapicon_cat"},
   }
 ```
+
 The keys of the codes above provide the labels on the chooser, **taxo** should be one of the available taxon id from the list and **iconClass** specifies the user provided icons to use.
 
 **initial** specifies the start up species when the component is first mounted, it should be one of the keys on the provided available species.
 
-
 ## Project setup from Github
 
 The source code is available from Github, it can be found here: https://github.com/ABI-Software/flatmapvuer .
 
 ### Clone the respositroy
+
 ```bash
 git clone https://github.com/ABI-Software/flatmapvuer.git
 ```
 
 ### Setup
+
 ```bash
 npm install
 ```
 
 ### Compiles and minifies for production
+
 ```bash
 npm run build-bundle
 ```
 
 ### Run the sample application
+
 ```bash
 npm run serve
 ```
 
-
 ## Documentation
 
 The documentation is developed with `vitepress` and `vuese`. Documentation pages are in the `docs` folder.
 
 ### To run in local development mode
+
 ```bash
 npm run docs:watch
 ```
+
 This will start the documentation server with `vitepress` on port `:5173` and watch the `FlatmapVuer` and `MultiFlatmapVuer` components changes.

package/cypress.config.js

@@ -1,16 +1,16 @@
-import { defineConfig } from "cypress";
+import { defineConfig } from 'cypress';
 import { configureVisualRegression } from 'cypress-visual-regression';
 
 const config = defineConfig({
-  "viewportWidth": 1920,
-  "viewportHeight": 1080,
+  viewportWidth: 1920,
+  viewportHeight: 1080,
   defaultCommandTimeout: 30000,
   // reporter: "junit",
   experimentalMemoryManagement: true,
   numTestsKeptInMemory: 0,
-  reporter: "cypress-multi-reporters",
+  reporter: 'cypress-multi-reporters',
   reporterOptions: {
-    configFile: "reporter-config.json"
+    configFile: 'reporter-config.json',
   },
   env: {
     projectId: process.env.CYPRESS_PROJECT_ID,
@@ -27,26 +27,26 @@ const config = defineConfig({
     MOUSE_UUID: process.env.MOUSE_UUID ? process.env.MOUSE_UUID : '',
     PIG_UUID: process.env.PIG_UUID ? process.env.PIG_UUID : '',
     CAT_UUID: process.env.CAT_UUID ? process.env.CAT_UUID : '',
-    ERROR_TOLERANCE: process.env.ERROR_TOLERANCE ? process.env.ERROR_TOLERANCE : 0.0001
+    ERROR_TOLERANCE: process.env.ERROR_TOLERANCE ? process.env.ERROR_TOLERANCE : 0.0001,
   },
   component: {
-    specPattern: "cypress/component/*.cy.js",
+    specPattern: 'cypress/component/*.cy.js',
     devServer: {
-      framework: "vue",
-      bundler: "vite",
+      framework: 'vue',
+      bundler: 'vite',
     },
     screenshotsFolder: './cypress/screenshots',
-    setupNodeEvents(on, config) {
-      configureVisualRegression(on)
+    setupNodeEvents(on, _config) {
+      configureVisualRegression(on);
 
       on('before:browser:launch', (browser, launchOptions) => {
         if (browser.name === 'chrome' && browser.isHeadless) {
           // fullPage screenshot size is 1400x1200 on non-retina screens
           // and 2800x2400 on retina screens
-          launchOptions.args.push('--window-size=1400,1200')
+          launchOptions.args.push('--window-size=1400,1200');
 
           // force screen to be non-retina (1400x1200 size)
-          launchOptions.args.push('--force-device-scale-factor=1')
+          launchOptions.args.push('--force-device-scale-factor=1');
 
           // force screen to be retina (2800x2400 size)
           // launchOptions.args.push('--force-device-scale-factor=2')
@@ -54,19 +54,19 @@ const config = defineConfig({
 
         if (browser.name === 'electron' && browser.isHeadless) {
           // fullPage screenshot size is 1400x1200
-          launchOptions.preferences.width = 2000
-          launchOptions.preferences.height = 2000
+          launchOptions.preferences.width = 2000;
+          launchOptions.preferences.height = 2000;
         }
 
         if (browser.name === 'firefox' && browser.isHeadless) {
           // menubars take up height on the screen
           // so fullPage screenshot size is 1400x1126
-          launchOptions.args.push('--width=1400')
-          launchOptions.args.push('--height=1200')
+          launchOptions.args.push('--width=1400');
+          launchOptions.args.push('--height=1200');
         }
 
-        return launchOptions
-      })
+        return launchOptions;
+      });
     },
   },
 });