SimplifiedSearch 1.1.5

.NET Standard 2.0
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package SimplifiedSearch --version 1.1.5
NuGet\Install-Package SimplifiedSearch -Version 1.1.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SimplifiedSearch" Version="1.1.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SimplifiedSearch --version 1.1.5
#r "nuget: SimplifiedSearch, 1.1.5"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install SimplifiedSearch as a Cake Addin
#addin nuget:?package=SimplifiedSearch&version=1.1.5

// Install SimplifiedSearch as a Cake Tool
#tool nuget:?package=SimplifiedSearch&version=1.1.5

License: MIT See Acknowledgements for additional license information covering parts of the project.
Quality Gate Status

SimplifiedSearch

Simple way to add ranked fuzzy matching search.
For when you have up to a few thousand products, locations or similar and want to add a search that most users will see as smart, with minimal work.

Intended use case

Searching through lists of short phrases like country names or the subject line in emails.
Data in databases must first be loaded into memory in order to be searched.

.NET support

Tested with: .NETFramework4.8, NETCOREAPP3.1, NET5.0, NET6.0

Quickstart

Install

Nuget
> dotnet add package SimplifiedSearch

Code

Use extension method .SimplifiedSearchAsync(searchTerm, propertyToSearchLambda).
propertyToSearchLambda is optional. When missing, all properties will be searched (or the value, if the value is string, Enum, int, etc).

using SimplifiedSearch;

IList<Country> countries = GetListOfCountries();
IList<Country> matches = await countries.SimplifiedSearchAsync("thaiwan", x => x.CountryName);
foreach (var country in matches)
{
    Console.WriteLine(country.CountryName);
}
// output:
// Taiwan
// Thailand

Acknowledgements

https://github.com/apache/lucenenet

Lucenenet is the main inspiration for SimplifiedSearch.
SimplifiedSearch was started with the goal of delivering similar results to a spesific setup of Lucene analyzer and query.

https://github.com/ninjanye/SearchExtensions

SearchExtensions is another inspiration for SimplifiedSearch.
SimplifiedSearch delivers a simpler (and less configurable) experience.

https://github.com/DanHarltey/Fastenshtein

Provides the distance calculation needed for fuzzy search.
License: MIT https://github.com/DanHarltey/Fastenshtein/blob/master/LICENSE.

https://github.com/thecoderok/Unidecode.NET

Provides the ascii folding needed to match accented characters to their ascii approximate equivalent (â, å, à, á, ä ≈ a).
License: MIT https://github.com/thecoderok/Unidecode.NET/blob/master/LICENSE.

https://github.com/annexare/Countries

For test data tests/data/annexare/Countries/*.
License: MIT tests/data/annexare/Countries/LICENSE.

https://github.com/CivilServiceUSA/us-states

For test data tests/data/CivilServiceUSA/us-states/*.
License: MIT tests/data/CivilServiceUSA/us-states/LICENSE.

https://github.com/linanqiu/reddit-dataset

For test data tests/data/linanqiu/reddit-dataset/*.
License: MIT tests/data/linanqiu/reddit-dataset/README.md (se bottom of readme).

Contributing

Bug reports, feature requests and pull requests are welcome.

  • The focus of the project is in making the simple use case work well, not on supporting many special cases.
  • For significant changes, make an issue for discussion before putting significant work into the change.
  • Follow the established code format.
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.0-beta.2 54 9/10/2022
1.2.0-beta.1 65 8/20/2022
1.1.5 456 1/9/2022
1.1.4 180 12/2/2021
1.1.3 160 12/1/2021
1.1.2 1,261 11/28/2021
1.1.0 1,041 11/20/2021
1.0.0 197 11/16/2021