vault-widget-ts
v0.0.0
Published
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Readme
React + TypeScript + Vite
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- @vitejs/plugin-react uses Babel for Fast Refresh
- @vitejs/plugin-react-swc uses SWC for Fast Refresh
Expanding the ESLint configuration
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
- Configure the top-level
parserOptionsproperty like this:
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
});- Replace
tseslint.configs.recommendedtotseslint.configs.recommendedTypeCheckedortseslint.configs.strictTypeChecked - Optionally add
...tseslint.configs.stylisticTypeChecked - Install eslint-plugin-react and update the config:
// eslint.config.js
import react from 'eslint-plugin-react';
export default tseslint.config({
// Set the react version
settings: { react: { version: '18.2' } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
},
});Building the Local Server and Bundle
To build the local server and bundle the project, follow these steps:
Install dependencies:
npm installStart the development server:
npm run devBuild the project for production:
npm run buildPreview the production build:
npm run preview
HUE component
Geico Hue components package is hosted in Azure Artifacts and when you are installing, it’s searching in the public NPM registry. You will need to include a .npmrc file in your project that will point your search to our internal registry. Here’s info about setting up an .npmrc file (https://geico.visualstudio.com/Digital%20Experience/_artifacts/feed/DigitalExperience/connect)
Lint and prettify
Install the Prettier Extension
- Open VS Code.
- Go to the Extensions Marketplace (Ctrl+Shift+X or Cmd+Shift+X on macOS).
- Search for Prettier - Code formatter and install it.
Configure VS Code Settings
You need to configure VS Code to format files with Prettier on save.
- Open the Settings JSON File:
- Press Ctrl+, (or Cmd+, on macOS) to open the Settings UI.
- Click the icon in the top-right corner ({}) to open settings.json.
- Add the Following Settings:
{ "editor.formatOnSave": true, // Enable formatting on save "editor.defaultFormatter": "esbenp.prettier-vscode", // Set Prettier as the default formatter "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" // Specific to JavaScript }, "[typescript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" // Specific to TypeScript }, "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" // Specific to JSON } }editor.formatOnSave: Ensures files are formatted whenever you save.editor.defaultFormatter: Sets Prettier as the default formatter for the supported languages.
- Open the Settings JSON File:
Prettier Configuration in Project
To customize Prettier settings for your project, create a
.prettierrcfile in the root of your project:Example
.prettierrc:{ "semi": true, "singleQuote": true, "trailingComma": "es5" }You can also use
.prettierrc.json,.prettierrc.js, or.prettierrc.yamlbased on your preferences.
