@citizenplane/pimp 6.4.1 → 8.0.0

package/.eslintrc.js

@@ -3,16 +3,13 @@ module.exports = {
   env: {
     browser: true,
     node: true,
+    jest: true,
   },
-  parserOptions: {
-    parser: 'babel-eslint',
-  },
-  extends: ['plugin:vue/recommended', 'plugin:prettier/recommended', 'prettier', 'prettier/vue'],
-  // required to lint *.vue files
-  plugins: ['vue', 'prettier'],
+  extends: ['eslint:recommended', 'plugin:vue/vue3-recommended', '@vue/prettier'],
   // add your custom rules here
   rules: {
     'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
     'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'vue/multi-word-component-names': 'off',
   },
 }

package/.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+  "*.{js,vue}": "npm run lint",
+  "*": "npm run format"
+}

package/README.md

@@ -14,6 +14,7 @@
 <br />
 
 ---
+
 ## Pimp mission
 
 Pimp aims to bring order and consistency to all of our products and processes. We elevate user experience and increase the speed and efficiency of how we design and build products.
@@ -33,8 +34,11 @@ yarn add @citizenplane/pimp
 ```
 
 ## Usage
+
 ### In a nuxt project
-1. Add this line to your `nuxt-config.js`: 
+
+1. Add this line to your `nuxt-config.js`:
+
 ```javascript
 // nuxt-config.js
 ...
@@ -48,20 +52,20 @@ css: [
 
 ```vue
 <template>
-  <cp-button appearance='primary' color='purple' />
+  <cp-button appearance="primary" color="purple" />
 </template>
 <script>
 import CpButton from '@citizenplane/pimp'
 
 export default {
   components: {
-    CpButton
+    CpButton,
   },
 }
 </script>
 ```
 
-If you want to use any component without having to import them manually, you can create a plugin:  
+If you want to use any component without having to import them manually, you can create a plugin:
 
 1. Create a plugin called `citizenplane-pimp.js`:
 
@@ -73,6 +77,7 @@ import Pimp from '@citizenplane/pimp'
 
 Vue.use(Pimp)
 ```
+
 2. Add this line to your `nuxt-config.js`:
 
 ```javascript
@@ -83,19 +88,23 @@ plugins: [
 ]
 ...
 ```
+
 3. Use components directly in your project without having to import nor declaring them:
+
 ```vue
 <template>
-  <cp-button appearance='primary' color='purple' />
+  <cp-button appearance="primary" color="purple" />
 </template>
 ```
 
 ## Components
+
 Now that you're all set up, you can retrieve components documentation on [pimp.citizenplane.com](https://pimp.citizenplane.com).
 
 ![CitizenPlane's design system hero banner](https://i.imgur.com/WFPUfiW.png)
 
 ## 🧑‍💻 Contributing to Pimp
+
 We are working on making this project a fully open source. We appreciate any contributions you might make.
 
 ### 🍴 Step 1. Fork this repository
@@ -123,7 +132,7 @@ Now go to `http://localhost:8080` in your browser.
 
 ### 🛠 Step 3. Make your changes
 
-Now you can start developing! 
+Now you can start developing!
 
 All the components are under the `src/components/` directory and associated code changes will automatically be reflected in the playground.
 
@@ -148,9 +157,11 @@ To be done
 Congrats, you're officially a Pimp contributor!
 
 ## Feedback
+
 We want to provide only components of the highest quality. We can’t do that without your feedback. If you have any suggestions about what we can do to improve components, please report it directly as an issue or drop us a line at <a href="mailto:tech@citizenplane.com">tech@citizenplane.com</a>.
 
 ## 👏 Respect earns Respect
+
 Please respect our Code of Conduct, in short:
 
 - Using welcoming and inclusive language
@@ -160,6 +171,7 @@ Please respect our Code of Conduct, in short:
 - Showing empathy towards other community members
 
 ## License
+
 Pimp is released under the MIT license.
 
 Copyright © 2021 CitizenPlane, Inc.