Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md with minimal Node version #1788

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Conversation

irevoire
Copy link
Member

@irevoire irevoire commented Dec 2, 2024

with the minimum version of node required

Hey, I tried to run the test and encountered multiple errors coming from our outdated CONTRIBUTING.md.

It says the minimum version of node supported is the v14, but when I tried it gave me this error:
image

Then I tried the v15 and it gave me this error:
image

Finally, the v16 worked, so the range of accepted version should be v16 to v18.


Then I tried to run the tests, which doesn't work anymore because apparently we now requires the installation of vitest

with minimum version of node required
Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.81%. Comparing base (8167a99) to head (e2e85ff).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1788   +/-   ##
=======================================
  Coverage   97.81%   97.81%           
=======================================
  Files          17       17           
  Lines        1465     1465           
  Branches      307      307           
=======================================
  Hits         1433     1433           
  Misses         32       32           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch we forgot to update this!!
thank you!

bors merge

@curquiza curquiza added the maintenance Issue about maintenance (CI, tests, refacto...) label Dec 2, 2024
@curquiza curquiza changed the title Update CONTRIBUTING.md Update CONTRIBUTING.md with minimal Node version Dec 2, 2024
Copy link
Contributor

meili-bors bot commented Dec 2, 2024

@meili-bors meili-bors bot merged commit 756d856 into main Dec 2, 2024
7 checks passed
@meili-bors meili-bors bot deleted the irevoire-patch-1 branch December 2, 2024 12:51
Comment on lines +37 to +39
- Node.js >= v16 and node <= 18
- Yarn

- vitest
Copy link
Collaborator

@flevi29 flevi29 Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While it might run on Node.js 16, we're not testing it, we're testing 18 and 20. And we shouldn't as it's End Of Life.
vitest shouldn't be required, yarn installs it, it's part of the devDependencies.

I guess it's fine for now, I might tweak it in the future. Also Node.js 18 EOL is approaching, when it arrives, I'll change this.

meili-bors bot added a commit that referenced this pull request Dec 23, 2024
1797: Update version for the next release (v0.47.0) r=curquiza a=meili-bot

_This PR is auto-generated._

The automated script updates the version of meilisearch-js to a new version: "v0.47.0"

CHANGELOGS 👇

This version introduces features released on Meilisearch v1.12.0 🎉

Check out the [Meilisearch v1.12.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.12.0) for more information.

## 🚀 Enhancements

- **Addition:** #1775 

Introducing new methods to get one or several batches, respectively `getBatch()` and `getBatches()`.

```ts
// fetch one batch using batch UID
const batch = await client.getBatch(123)

// fetch all batches
const batches = await client.getBatches()
```

- **Addition:** #1774 

The `getTasks()` methods now accept a `reverse` parameter to retrieve tasks in reverse chronological order.

```ts
const tasks = await client.getTasks({ reverse: true });
```

- **Addition:** #1790

Index settings now allow disabling **prefix search** and **facet search**. They're both enabled by default. The SDK now comes with dedicated methods to configure these settings.

```ts
// disable prefix search
await client.index('myIndex').updatePrefixSearch('disabled')
// reset prefix search settings
await client.index('myIndex').resetPrefixSearch()

// disable facet search
await client.index('myIndex').updateFacetSearch(false)
// reset facet search settings
await client.index('myIndex').resetFacetSearch()
```

- **Update:** #1773 

The `_matchesPosition` array now contains an `indices` array the text was matched in an array.

When searching for `fantasy` in a document that has a searchable `genre` field with the value `genre: ["fantasy", "adventure"]`, the matches position will be as follow: 

```ts
{
  genre: [{ start: 0, length: 7, indices: [0] }]
}
```

Which means:
- There was a single match in the `genre` array (array length == 1)
- The match started as position `0` (the first character, "f")
- The match has a length of `7` (the entire "fantasy" word)
- The match was in the first item of the array (indices == [0]) 

⚙️ Maintenance/misc

- Update CONTRIBUTING.md with minimal Node version (#1788) 

Thanks again to `@/irevoire,` `@/Barabasbalazs,` `@/irevoire,` `@/curquiza,` and `@/Strift.` 🎉

Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Issue about maintenance (CI, tests, refacto...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants