Merge #407

407: Update wording from `MeiliSearch` to `Meilisearch` r=bidoubiwa a=nicolasvienot

# Pull Request

## What does this PR do?
Fixes #
`@bidoubiwa` Feel free to create an issue if needed

Update wording from `MeiliSearch` to `Meilisearch`

I omitted the example on `How to use meilisearch-js` in `README.md` and the `meilisearch-js` import in `client.js` and `meilisearch.test.js` as we need to import `MeiliSearch` from this lib.

<!-- Please link the issue you're trying to fix with this PR, if none then please create an issue first. -->


Co-authored-by: nicolasvienot <[email protected]>
Co-authored-by: cvermand <[email protected]>

Author: 3 people

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,7 +22,7 @@ If applicable, add screenshots or logs to help explain your problem.
 
 **Environment (please complete the following information):**
 - OS: [e.g. Debian GNU/Linux]
-- MeiliSearch version: [e.g. v.0.20.0]
+- Meilisearch version: [e.g. v.0.20.0]
 - strapi-plugin-meilisearch version: [e.g v0.3.1]
 - Browser: [e.g. Chrome version 90.0]
 - Strapi version: [e.g. v3.6.2]

README.md

@@ -313,7 +313,7 @@ module.exports = {
   meilisearch: {
     config: {
       restaurant: {
-        filterEntry({ entry }) { // can also be async 
+        filterEntry({ entry }) { // can also be async
           return entry.title !== `Alfredo`
         },
       },

package.json

@@ -1,7 +1,7 @@
 {
   "name": "strapi-plugin-meilisearch",
   "version": "0.6.4",
-  "description": "Synchronise and search in your Strapi content-types with MeiliSearch",
+  "description": "Synchronise and search in your Strapi content-types with Meilisearch",
   "scripts": {
     "playground:dev": "yarn --cwd ./playground && yarn --cwd ./playground develop",
     "playground:build": "yarn --cwd ./playground && yarn --cwd ./playground build",
@@ -13,7 +13,7 @@
   "strapi": {
     "name": "meilisearch",
     "icon": "search",
-    "description": "Search in your content-types with the MeiliSearch plugin",
+    "description": "Search in your content-types with the Meilisearch plugin",
     "kind": "plugin"
   },
   "files": [

resources/meilisearch-settings/make-relationship-filterable.js

@@ -2,7 +2,7 @@
  * Imagine if you have a content-type restaurant with a categories field.
  * Category is a content-type of its own. They have a many-to-many relationship.
  *
- * In MeiliSearch you can use filters to for example in our case, only find italian restaurants.
+ * In Meilisearch you can use filters to for example in our case, only find italian restaurants.
  * To be able to do that, you need to provide a list of values and add in the settings the field in `filterableAttributes`.
  * See guide: https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html#configuring-filters
  *
@@ -17,7 +17,7 @@
  *   ]
  * }
  *
- * Since MeiliSearch is expecting `category: ["Italian", "french"]` and
+ * Since Meilisearch is expecting `category: ["Italian", "french"]` and
  * also `category` to be in `filterableAttributes` we can use the model configuration file to provide all these informations.
  */
 

server/__tests__/configuration-validation.test.js

@@ -22,7 +22,7 @@ describe('Test plugin configuration', () => {
     expect(fakeStrapi.log.warn).toHaveBeenCalledTimes(0)
     expect(fakeStrapi.log.error).toHaveBeenCalledTimes(1)
     expect(fakeStrapi.log.error).toHaveBeenCalledWith(
-      'The `config` field in the MeiliSearch plugin configuration must be of type object'
+      'The `config` field in the Meilisearch plugin configuration must be of type object'
     )
   })
 
@@ -58,7 +58,7 @@ describe('Test plugin configuration', () => {
     expect(fakeStrapi.log.warn).toHaveBeenCalledTimes(0)
     expect(fakeStrapi.log.error).toHaveBeenCalledTimes(1)
     expect(fakeStrapi.log.error).toHaveBeenCalledWith(
-      '`host` should be a non-empty string in MeiliSearch configuration'
+      '`host` should be a non-empty string in Meilisearch configuration'
     )
   })
 
@@ -85,7 +85,7 @@ describe('Test plugin configuration', () => {
     expect(fakeStrapi.log.warn).toHaveBeenCalledTimes(0)
     expect(fakeStrapi.log.error).toHaveBeenCalledTimes(1)
     expect(fakeStrapi.log.error).toHaveBeenCalledWith(
-      '`apiKey` should be a string in MeiliSearch configuration'
+      '`apiKey` should be a string in Meilisearch configuration'
     )
   })
 

server/__tests__/meilisearch.test.js

@@ -1,7 +1,7 @@
 const createMeilisearchService = require('../services/meilisearch')
 
 const { createFakeStrapi } = require('./utils/fakes')
-const { MeiliSearch } = require('meilisearch')
+const { MeiliSearch: Meilisearch } = require('meilisearch')
 
 jest.mock('meilisearch')
 
@@ -38,7 +38,7 @@ const mockIndex = jest.fn(() => ({
 }))
 
 // @ts-ignore
-MeiliSearch.mockImplementation(() => {
+Meilisearch.mockImplementation(() => {
   return {
     getIndexes,
     index: mockIndex,

server/configuration-validation.js

@@ -13,7 +13,7 @@ function validateConfiguration(config) {
 
   if (!isObject(config)) {
     strapi.log.error(
-      'The `config` field in the MeiliSearch plugin configuration must be of type object'
+      'The `config` field in the Meilisearch plugin configuration must be of type object'
     )
     config = {}
   }
@@ -22,14 +22,14 @@ function validateConfiguration(config) {
   // Validate the `host` parameter
   if ((host !== undefined && typeof host !== 'string') || config.host === '') {
     strapi.log.error(
-      '`host` should be a non-empty string in MeiliSearch configuration'
+      '`host` should be a non-empty string in Meilisearch configuration'
     )
     delete config.host
   }
 
   // Validate the `apikey` parameter
   if (apiKey !== undefined && typeof apiKey !== 'string') {
-    strapi.log.error('`apiKey` should be a string in MeiliSearch configuration')
+    strapi.log.error('`apiKey` should be a string in Meilisearch configuration')
     delete config.apiKey
   }
 

server/services/meilisearch/client.js

@@ -1,11 +1,11 @@
 'use strict'
-const { MeiliSearch } = require('meilisearch')
+const { MeiliSearch: Meilisearch } = require('meilisearch')
 
 /**
- * Create a MeiliSearch client instance.
+ * Create a Meilisearch client instance.
  *
  * @param  {object} config - Information to pass to the constructor.
  *
- * @returns { object } - MeiliSearch client instance.
+ * @returns { object } - Meilisearch client instance.
  */
-module.exports = config => new MeiliSearch(config)
+module.exports = config => new Meilisearch(config)

server/services/meilisearch/config.js

@@ -35,7 +35,7 @@ module.exports = ({ strapi }) => {
     },
 
     /**
-     * Transform contentTypes entries before indexation in MeiliSearch.
+     * Transform contentTypes entries before indexation in Meilisearch.
      *
      * @param {object} options
      * @param {string} options.contentType - ContentType name.
@@ -76,7 +76,7 @@ module.exports = ({ strapi }) => {
     },
 
     /**
-     * Filter contentTypes entries before indexation in MeiliSearch.
+     * Filter contentTypes entries before indexation in Meilisearch.
      *
      * @param {object} options
      * @param {string} options.contentType - ContentType name.
@@ -119,15 +119,15 @@ module.exports = ({ strapi }) => {
     },
 
     /**
-     * Returns MeiliSearch index settings from model definition.
+     * Returns Meilisearch index settings from model definition.
      *
      * @param {object} options
      * @param {string} options.contentType - ContentType name.
      * @param {Array<Object>} [options.entries]  - The data to convert. Conversion will use
 
      * @typedef Settings
      * @type {import('meilisearch').Settings}
-     * @return {Settings} - MeiliSearch index settings
+     * @return {Settings} - Meilisearch index settings
      */
     getSettings: function ({ contentType }) {
       const collection = contentTypeService.getCollectionName({ contentType })

server/services/meilisearch/connector.js

@@ -1,5 +1,5 @@
 'use strict'
-const MeiliSearch = require('./client')
+const Meilisearch = require('./client')
 
 /**
  * Add one entry from a contentType to its index in Meilisearch.
@@ -62,7 +62,7 @@ module.exports = ({ strapi, adapter, config }) => {
     getIndexes: async function () {
       try {
         const { apiKey, host } = await store.getCredentials()
-        const client = MeiliSearch({ apiKey, host })
+        const client = Meilisearch({ apiKey, host })
         const indexes = await client.getIndexes()
         return indexes
       } catch (e) {
@@ -82,7 +82,7 @@ module.exports = ({ strapi, adapter, config }) => {
      */
     deleteEntriesFromMeiliSearch: async function ({ contentType, entriesId }) {
       const { apiKey, host } = await store.getCredentials()
-      const client = MeiliSearch({ apiKey, host })
+      const client = Meilisearch({ apiKey, host })
 
       const indexUid = config.getIndexNameOfContentType({ contentType })
       const documentsIds = entriesId.map(entryId =>
@@ -103,7 +103,7 @@ module.exports = ({ strapi, adapter, config }) => {
      */
     updateEntriesInMeilisearch: async function ({ contentType, entries }) {
       const { apiKey, host } = await store.getCredentials()
-      const client = MeiliSearch({ apiKey, host })
+      const client = Meilisearch({ apiKey, host })
 
       if (!Array.isArray(entries)) entries = [entries]
 
@@ -139,7 +139,7 @@ module.exports = ({ strapi, adapter, config }) => {
     getStats: async function ({ indexUid }) {
       try {
         const { apiKey, host } = await store.getCredentials()
-        const client = MeiliSearch({ apiKey, host })
+        const client = Meilisearch({ apiKey, host })
         return await client.index(indexUid).getStats()
       } catch (e) {
         return {
@@ -232,7 +232,7 @@ module.exports = ({ strapi, adapter, config }) => {
      */
     addEntriesToMeilisearch: async function ({ contentType, entries }) {
       const { apiKey, host } = await store.getCredentials()
-      const client = MeiliSearch({ apiKey, host })
+      const client = Meilisearch({ apiKey, host })
 
       if (!Array.isArray(entries)) entries = [entries]
 
@@ -260,7 +260,7 @@ module.exports = ({ strapi, adapter, config }) => {
      */
     addContentTypeInMeiliSearch: async function ({ contentType }) {
       const { apiKey, host } = await store.getCredentials()
-      const client = MeiliSearch({ apiKey, host })
+      const client = Meilisearch({ apiKey, host })
       const indexUid = config.getIndexNameOfContentType({ contentType })
 
       // Get Meilisearch Index settings from model
@@ -347,7 +347,7 @@ module.exports = ({ strapi, adapter, config }) => {
         })
       } else {
         const { apiKey, host } = await store.getCredentials()
-        const client = MeiliSearch({ apiKey, host })
+        const client = Meilisearch({ apiKey, host })
 
         const indexUid = config.getIndexNameOfContentType({ contentType })
         await client.index(indexUid).delete()