mirror of
https://github.com/samber/lo.git
synced 2026-04-22 15:37:14 +08:00
feat(doc): add a brand new Docusaurus website for documentation 🎨
This commit is contained in:
Samuel Berthe
@@ -0,0 +1,20 @@
|
||||
# Dependencies
|
||||
/node_modules
|
||||
|
||||
# Production
|
||||
/build
|
||||
|
||||
# Generated files
|
||||
.docusaurus
|
||||
.cache-loader
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
@@ -0,0 +1,41 @@
|
||||
# Website
|
||||
|
||||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
yarn
|
||||
```
|
||||
|
||||
## Local Development
|
||||
|
||||
```bash
|
||||
yarn start
|
||||
```
|
||||
|
||||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
```
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
|
||||
## Deployment
|
||||
|
||||
Using SSH:
|
||||
|
||||
```bash
|
||||
USE_SSH=true yarn deploy
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```bash
|
||||
GIT_USER=<Your GitHub username> yarn deploy
|
||||
```
|
||||
|
||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Documentation",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Learn how to use samber/lo - the reusable utility library for Go."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: ✌️ About
|
||||
description: Discover "lo", the utility library for Go
|
||||
sidebar_position: 0
|
||||
---
|
||||
|
||||
# ✌️ About
|
||||
|
||||
**samber/lo** is a Lodash-style utility library for Go that brings the power and convenience of functional programming helpers to the Go ecosystem. Born from the need for more expressive and concise data manipulation, `lo` fills the gaps between Go's standard library and the complex data transformations that modern applications require.
|
||||
|
||||
## Why `lo` Exists
|
||||
|
||||
Go's standard library is excellent for many use cases, but it lacks the higher-level abstractions that developers coming from JavaScript, Python, or other languages often miss. While Go 1.18 introduced generics, the standard library's `slices` and `maps` packages only cover about 5-10 basic helpers. `lo` provides hundreds of additional utilities that make everyday programming tasks more enjoyable and less error-prone.
|
||||
|
||||
## Design Philosophy
|
||||
|
||||
### 1. **Type Safety Through Generics**
|
||||
Every function in `lo` is built on Go 1.18+ generics, ensuring compile-time type safety without sacrificing flexibility. This eliminates runtime type assertions and reduces bugs.
|
||||
|
||||
### 2. **Immutable by Default**
|
||||
The main `lo` package follows functional programming principles by returning new collections rather than modifying existing ones. This predictability makes code easier to reason about and test.
|
||||
|
||||
### 3. **Performance When Needed**
|
||||
For performance-critical scenarios, `lo` offers specialized packages:
|
||||
- `lo/mutable`: In-place operations that modify collections directly
|
||||
- `lo/parallel`: Concurrent processing with built-in worker pools
|
||||
- `lo/it`: Lazy evaluation using Go 1.23+ iterators
|
||||
|
||||
### 4. **Minimal Dependencies**
|
||||
`lo` has zero dependencies outside the Go standard library. This choice ensures reliability, security, and avoids dependency hell.
|
||||
|
||||
## Key Design Decisions
|
||||
|
||||
### Function Naming
|
||||
Functions follow familiar patterns from Lodash and other functional libraries, making the learning curve gentle for developers with experience in other ecosystems.
|
||||
|
||||
### Play Links
|
||||
Every function includes a "Play" link to the Go Playground, allowing developers to quickly experiment and understand behavior without setting up a local environment.
|
||||
|
||||
### Variadic Functions
|
||||
Many functions accept variadic parameters (like `Keys()` accepting multiple maps), providing flexibility while maintaining type safety.
|
||||
|
||||
### Slice Type Parameters
|
||||
Functions use `~[]T` constraints to accept any slice type, including named slice types, not just `[]T`. This design choice makes the library more flexible in real-world usage.
|
||||
|
||||
## The Name "lo"
|
||||
|
||||
The name was chosen to be short and memorable, similar to "Lodash". It's easy to type and no existing Go package was using this name, making it unique in the ecosystem.
|
||||
|
||||
## Community and Evolution
|
||||
|
||||
`lo` embraces Go's evolution:
|
||||
- **Go 1.18**: Leveraged generics for type safety
|
||||
- **Go 1.23**: Added iterator support with the `it` package
|
||||
- **Future**: Will continue to adapt to Go's language improvements
|
||||
|
||||
The library is actively maintained and welcomes contributions. It follows semantic versioning strictly, ensuring stability for production applications.
|
||||
|
||||
## When to Use `lo`
|
||||
|
||||
Use `lo` when you need to:
|
||||
- Transform complex data structures concisely
|
||||
- Reduce boilerplate code for common operations
|
||||
- Write more declarative and readable code
|
||||
- Leverage functional programming patterns in Go
|
||||
- Process data in parallel or with lazy evaluation
|
||||
|
||||
For simple operations, Go's standard library may suffice. But when you find yourself writing nested loops or complex data manipulation logic, `lo` provides the abstractions you need.
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
title: 🚀 Getting started
|
||||
description: Let's discover samber/lo in less than 5 minutes.
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Getting started
|
||||
|
||||
**samber/lo** is a Lodash-style utility library for Go 1.18+ that leverages generics to provide type-safe helper functions. The library is organized into several packages, each serving different use cases.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go get -u github.com/samber/lo
|
||||
```
|
||||
|
||||
## Base Package (`lo`)
|
||||
|
||||
The main package provides immutable utility functions for slices, maps, strings, math operations, and more. It's the core of the library with over 300+ functions.
|
||||
|
||||
```go
|
||||
import "github.com/samber/lo"
|
||||
|
||||
// Example: Map a slice of numbers to their squares
|
||||
numbers := []int{1, 2, 3, 4, 5}
|
||||
squared := lo.Map(numbers, func(x int, _ int) int {
|
||||
return x * x
|
||||
})
|
||||
// Result: [1, 4, 9, 16, 25]
|
||||
```
|
||||
|
||||
## Iter Package (`lo/iter`)
|
||||
|
||||
The `it` package provides Go 1.23+ sequence helpers with lazy evaluation, offering over 100 functions for efficient iteration without buffering.
|
||||
|
||||
```go
|
||||
// Future usage (Go 1.23+)
|
||||
import (
|
||||
"iter"
|
||||
loit "github.com/samber/lo/it"
|
||||
)
|
||||
|
||||
// Lazy iteration without buffering
|
||||
seq := loit.Filter(iter.Range(0, 1000), func(x int) bool {
|
||||
return x%2 == 0
|
||||
})
|
||||
```
|
||||
|
||||
## Mutable Package (`lo/mutable`)
|
||||
|
||||
The mutable package provides in-place operations that modify collections directly, useful for performance-critical scenarios.
|
||||
|
||||
```go
|
||||
import lom "github.com/samber/lo/mutable"
|
||||
|
||||
// Filter in-place (modifies the original slice)
|
||||
numbers := []int{1, 2, 3, 4, 5}
|
||||
lom.Filter(&numbers, func(x int) bool {
|
||||
return x%2 == 0
|
||||
})
|
||||
// Result: [2, 4]
|
||||
```
|
||||
|
||||
## Parallel Package (`lo/parallel`)
|
||||
|
||||
The parallel package enables concurrent processing of collections with built-in worker pools, perfect for CPU-intensive operations.
|
||||
|
||||
```go
|
||||
import lop "github.com/samber/lo/parallel"
|
||||
|
||||
// Process items concurrently (4 workers by default)
|
||||
results := lop.Map(numbers, 4, func(x int) int {
|
||||
// Some expensive operation
|
||||
return expensiveOperation(x)
|
||||
})
|
||||
```
|
||||
|
||||
## Key Benefits
|
||||
|
||||
- **Type-safe** with generics
|
||||
- **Immutable** by default (main package)
|
||||
- **Performance** optimized with parallel and mutable variants
|
||||
- **Comprehensive** with 500+ utility functions
|
||||
- **Lazy evaluation** with `iter` std package (Go >= 1.23)
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Check the [Go documentation](https://pkg.go.dev/github.com/samber/lo) for complete API reference
|
||||
- Explore examples in the repository
|
||||
- Choose the right sub-package for your use case
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: glossary
|
||||
title: 📚 Glossary
|
||||
description: Comprehensive glossary of samber/lo library terms and concepts
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Glossary
|
||||
|
||||
## Generics
|
||||
Go 1.18+ feature that allows writing functions and types that work with any type while maintaining type safety. The `lo` library extensively uses generics to provide type-safe utility functions.
|
||||
|
||||
## Reflection
|
||||
Language reflection is a programming technique where a program can examine and manipulate its own structure and behavior at runtime.
|
||||
|
||||
## Type Safety
|
||||
The principle of ensuring that operations are performed on the correct data types, preventing runtime errors. `lo` leverages Go's type system and generics to provide type-safe operations and type-safe APIs.
|
||||
|
||||
## Immutability
|
||||
The concept of data that cannot be changed after creation. Most `lo` functions follow immutable patterns, returning new collections rather than modifying existing ones.
|
||||
|
||||
## Predicate Function
|
||||
A function that returns a boolean value, typically used for filtering or testing conditions. In `lo`, predicates are commonly used with `Filter`, `Find`, `Contains`, etc.
|
||||
|
||||
## Transformer Function
|
||||
A function that transforms one value into another. Used with `Map`, `MapValues`, and other transformation operations.
|
||||
|
||||
## Reducer Function
|
||||
A function that combines two values into one, used with `Reduce` and similar operations.
|
||||
|
||||
## Comparator Function
|
||||
A function that compares two values and returns their relative order. Used with sorting operations.
|
||||
|
||||
## Higher-Order Functions
|
||||
Functions that take other functions as parameters or return functions as results. Most `lo` utilities are higher-order functions.
|
||||
|
||||
## Mutable Operations
|
||||
Functions that modify collections in-place rather than creating new ones. Mutable operations can be more memory efficient but less safe in concurrent scenarios and when data sharing is involved.
|
||||
|
||||
## Lazy Evaluation
|
||||
Some `lo` operations implement lazy evaluation patterns for improved performance with large datasets.
|
||||
|
||||
## Memory Efficiency
|
||||
Considerations for memory usage when choosing between immutable and mutable operations. Mutable operations can be more memory efficient but less safe in concurrent scenarios and when data sharing is involved.
|
||||
|
||||
## Concurrency Safety
|
||||
How different operations behave in concurrent contexts and thread safety guarantees.
|
||||
@@ -0,0 +1,368 @@
|
||||
import {themes as prismThemes} from 'prism-react-renderer';
|
||||
import type {Config} from '@docusaurus/types';
|
||||
import type * as Preset from '@docusaurus/preset-classic';
|
||||
|
||||
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
|
||||
|
||||
const config: Config = {
|
||||
title: 'lo',
|
||||
tagline: 'A reusable utility library for Go: slices, maps, and more',
|
||||
favicon: 'img/favicon.ico',
|
||||
|
||||
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
|
||||
future: {
|
||||
v4: {
|
||||
removeLegacyPostBuildHeadAttribute: true,
|
||||
useCssCascadeLayers: true,
|
||||
},
|
||||
experimental_faster: {
|
||||
swcJsLoader: true,
|
||||
swcJsMinimizer: true,
|
||||
swcHtmlMinimizer: true,
|
||||
lightningCssMinimizer: true,
|
||||
rspackBundler: true,
|
||||
rspackPersistentCache: true,
|
||||
ssgWorkerThreads: true,
|
||||
mdxCrossCompilerCache: true,
|
||||
},
|
||||
experimental_storage: {
|
||||
type: 'localStorage',
|
||||
namespace: true,
|
||||
},
|
||||
},
|
||||
|
||||
// Set the production url of your site here
|
||||
url: 'https://ro.samber.dev',
|
||||
// Set the /<baseUrl>/ pathname under which your site is served
|
||||
// For GitHub pages deployment, it is often '/<projectName>/'
|
||||
baseUrl: '/',
|
||||
|
||||
// GitHub pages deployment config.
|
||||
// If you aren't using GitHub pages, you don't need these.
|
||||
organizationName: 'samber', // Usually your GitHub org/user name.
|
||||
projectName: 'lo', // Usually your repo name.
|
||||
|
||||
onBrokenLinks: 'throw',
|
||||
onBrokenMarkdownLinks: 'throw',
|
||||
onBrokenAnchors: 'throw',
|
||||
|
||||
markdown: {
|
||||
anchors: {
|
||||
maintainCase: true,
|
||||
},
|
||||
mermaid: true,
|
||||
},
|
||||
|
||||
// Storage configuration for better performance
|
||||
staticDirectories: ['static'],
|
||||
|
||||
// Optional: Enable hash router for offline support (experimental)
|
||||
// Uncomment if you need offline browsing capability
|
||||
// router: 'hash',
|
||||
|
||||
// Future-proofing configurations
|
||||
clientModules: [
|
||||
require.resolve('./src/theme/prism-include-languages.js'),
|
||||
],
|
||||
|
||||
// Even if you don't use internationalization, you can use this field to set
|
||||
// useful metadata like html lang. For example, if your site is Chinese, you
|
||||
// may want to replace "en" with "zh-Hans".
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en'],
|
||||
},
|
||||
|
||||
headTags: [
|
||||
// DNS prefetch for better performance
|
||||
{
|
||||
tagName: 'link',
|
||||
attributes: {
|
||||
rel: 'dns-prefetch',
|
||||
href: '//fonts.googleapis.com',
|
||||
},
|
||||
},
|
||||
{
|
||||
tagName: 'link',
|
||||
attributes: {
|
||||
rel: 'preconnect',
|
||||
href: 'https://fonts.gstatic.com',
|
||||
crossorigin: 'anonymous',
|
||||
},
|
||||
},
|
||||
{
|
||||
tagName: 'meta',
|
||||
attributes: {
|
||||
name: 'keywords',
|
||||
content: 'go, golang, lo, slices, maps, strings, channels, functions, helpers, concurrency, error handling, resusable, utility, framework, library, samber',
|
||||
},
|
||||
},
|
||||
{
|
||||
tagName: 'meta',
|
||||
attributes: {
|
||||
property: 'og:image',
|
||||
content: 'https://lo.samber.dev/img/cover.png',
|
||||
},
|
||||
},
|
||||
{
|
||||
tagName: 'meta',
|
||||
attributes: {
|
||||
name: 'twitter:card',
|
||||
content: 'summary_large_image',
|
||||
},
|
||||
},
|
||||
{
|
||||
tagName: 'meta',
|
||||
attributes: {
|
||||
name: 'twitter:image',
|
||||
content: 'https://lo.samber.dev/img/cover.png',
|
||||
},
|
||||
},
|
||||
{
|
||||
tagName: 'meta',
|
||||
attributes: {
|
||||
name: 'twitter:creator',
|
||||
content: '@samuelberthe',
|
||||
},
|
||||
},
|
||||
{
|
||||
tagName: 'link',
|
||||
attributes: {
|
||||
rel: 'canonical',
|
||||
href: 'https://lo.samber.dev',
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
presets: [
|
||||
[
|
||||
'classic',
|
||||
{
|
||||
docs: {
|
||||
sidebarPath: './sidebars.ts',
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
editUrl:
|
||||
'https://github.com/samber/lo/tree/master/docs/',
|
||||
showLastUpdateAuthor: true,
|
||||
showLastUpdateTime: true,
|
||||
// Enhanced docs features from 3.8+
|
||||
breadcrumbs: true,
|
||||
sidebarCollapsed: false,
|
||||
numberPrefixParser: false,
|
||||
// Enable admonitions
|
||||
admonitions: {
|
||||
keywords: ['note', 'tip', 'info', 'danger', 'warning'],
|
||||
extendDefaults: true,
|
||||
},
|
||||
// Enhanced markdown features
|
||||
remarkPlugins: [],
|
||||
rehypePlugins: [],
|
||||
},
|
||||
sitemap: {
|
||||
lastmod: 'date',
|
||||
changefreq: 'weekly',
|
||||
priority: 0.7,
|
||||
ignorePatterns: ['/tags/**'],
|
||||
filename: 'sitemap.xml',
|
||||
// Enhanced sitemap features from 3.8+
|
||||
createSitemapItems: async (params) => {
|
||||
const {defaultCreateSitemapItems, ...rest} = params ;
|
||||
const items = await defaultCreateSitemapItems(rest);
|
||||
// Add custom priority for specific pages
|
||||
return items.map((item) => {
|
||||
if (item.url.includes('/docs/getting-started')) {
|
||||
return {...item, priority: 1.0};
|
||||
}
|
||||
if (item.url.includes('/docs/')) {
|
||||
return {...item, priority: 0.8};
|
||||
}
|
||||
return item;
|
||||
});
|
||||
},
|
||||
},
|
||||
theme: {
|
||||
customCss: './src/css/custom.css',
|
||||
},
|
||||
gtag: {
|
||||
trackingID: 'G-VVXXV8747F',
|
||||
anonymizeIP: false,
|
||||
},
|
||||
} satisfies Preset.Options,
|
||||
],
|
||||
],
|
||||
|
||||
themeConfig: {
|
||||
// Replace with your project's social card
|
||||
image: 'img/cover.png',
|
||||
colorMode: {
|
||||
defaultMode: 'light',
|
||||
disableSwitch: false,
|
||||
respectPrefersColorScheme: true,
|
||||
},
|
||||
|
||||
// Mermaid configuration
|
||||
mermaid: {
|
||||
theme: {light: 'neutral', dark: 'dark'},
|
||||
options: {
|
||||
maxTextSize: 50000,
|
||||
},
|
||||
},
|
||||
|
||||
// Enhanced metadata
|
||||
metadata: [
|
||||
{name: 'og:type', content: 'website'},
|
||||
],
|
||||
|
||||
navbar: {
|
||||
title: '🏎️ samber/lo',
|
||||
logo: {
|
||||
alt: 'lo - Reusable utility library for Go',
|
||||
src: 'img/icon.png',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'docSidebar',
|
||||
position: 'left',
|
||||
label: 'Doc',
|
||||
},
|
||||
{
|
||||
to: 'https://pkg.go.dev/github.com/samber/lo',
|
||||
label: 'GoDoc',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
to: 'community',
|
||||
label: 'Community',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
to: 'https://github.com/samber/lo/releases',
|
||||
label: 'Changelog',
|
||||
position: 'right',
|
||||
},
|
||||
{
|
||||
href: 'https://github.com/samber/lo',
|
||||
position: 'right',
|
||||
className: 'header-github-link',
|
||||
'aria-label': 'GitHub repository',
|
||||
},
|
||||
{
|
||||
type: 'search',
|
||||
position: 'right',
|
||||
},
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: 'dark',
|
||||
links: [
|
||||
{
|
||||
title: 'Project',
|
||||
items: [
|
||||
{
|
||||
label: 'Documentation',
|
||||
to: '/docs/getting-started',
|
||||
},
|
||||
{
|
||||
label: 'Changelog',
|
||||
to: 'https://github.com/samber/ro/releases',
|
||||
},
|
||||
{
|
||||
label: 'Godoc',
|
||||
to: 'https://pkg.go.dev/github.com/samber/ro',
|
||||
},
|
||||
{
|
||||
label: 'License',
|
||||
to: 'https://github.com/samber/ro/blob/master/LICENSE',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Community',
|
||||
items: [
|
||||
{
|
||||
label: 'New issue',
|
||||
to: 'https://github.com/samber/lo/issues',
|
||||
},
|
||||
{
|
||||
label: 'GitHub',
|
||||
to: 'https://github.com/samber/lo',
|
||||
},
|
||||
{
|
||||
label: 'Stack Overflow',
|
||||
to: 'https://stackoverflow.com/search?q=samber+lo',
|
||||
},
|
||||
{
|
||||
label: 'Twitter',
|
||||
to: 'https://twitter.com/samuelberthe',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
copyright: `Copyright © ${new Date().getFullYear()} lo.`,
|
||||
},
|
||||
prism: {
|
||||
theme: prismThemes.github,
|
||||
darkTheme: prismThemes.dracula,
|
||||
defaultLanguage: 'go',
|
||||
additionalLanguages: ['bash', 'diff', 'json', 'yaml', 'go'],
|
||||
magicComments: [
|
||||
{
|
||||
className: 'theme-code-block-highlighted-line',
|
||||
line: 'highlight-next-line',
|
||||
block: {start: 'highlight-start', end: 'highlight-end'},
|
||||
},
|
||||
{
|
||||
className: 'code-block-error-line',
|
||||
line: 'error-next-line',
|
||||
block: {start: 'error-start', end: 'error-end'},
|
||||
},
|
||||
],
|
||||
},
|
||||
// algolia: {
|
||||
// appId: '',
|
||||
// // bearer:disable javascript_lang_hardcoded_secret
|
||||
// apiKey: '',
|
||||
// externalUrlRegex: 'lo\\.samber\\.dev',
|
||||
// indexName: 'lo',
|
||||
// contextualSearch: true,
|
||||
// searchParameters: {
|
||||
// // facetFilters: ['type:lvl1'],
|
||||
// },
|
||||
// searchPagePath: 'search',
|
||||
// // Enhanced search features from 3.8+
|
||||
// insights: false,
|
||||
// },
|
||||
} satisfies Preset.ThemeConfig,
|
||||
|
||||
themes: ['@docusaurus/theme-mermaid'],
|
||||
|
||||
plugins: [
|
||||
// Add ideal image plugin for better image optimization
|
||||
[
|
||||
'@docusaurus/plugin-ideal-image',
|
||||
{
|
||||
quality: 70,
|
||||
max: 1030,
|
||||
min: 640,
|
||||
steps: 2,
|
||||
disableInDev: false,
|
||||
},
|
||||
],
|
||||
[
|
||||
'vercel-analytics',
|
||||
{
|
||||
debug: true,
|
||||
mode: 'auto',
|
||||
},
|
||||
],
|
||||
// Custom plugin to generate helper category pages from data markdown
|
||||
[
|
||||
require.resolve('./plugins/helpers-pages'),
|
||||
{},
|
||||
],
|
||||
],
|
||||
};
|
||||
|
||||
export default config;
|
||||
Generated
+20232
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,63 @@
|
||||
{
|
||||
"name": "lo",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"docusaurus": "docusaurus",
|
||||
"start": "docusaurus start",
|
||||
"build": "docusaurus build",
|
||||
"swizzle": "docusaurus swizzle",
|
||||
"deploy": "docusaurus deploy",
|
||||
"clear": "docusaurus clear",
|
||||
"serve": "docusaurus serve",
|
||||
"write-translations": "docusaurus write-translations",
|
||||
"write-heading-ids": "docusaurus write-heading-ids",
|
||||
"typecheck": "tsc",
|
||||
"sync-function-signatures": "node ./scripts/sync-function-signatures.js",
|
||||
"check-function-signatures": "node ./scripts/sync-function-signatures.js --check",
|
||||
"check-cross-references": "node ./scripts/check-cross-references.js",
|
||||
"check-duplicates-in-category": "node ./scripts/check-duplicates-in-category.js",
|
||||
"check-filename-matches-frontmatter": "node ./scripts/check-filename-matches-frontmatter.js",
|
||||
"check-similar-exists": "node ./scripts/check-similar-exists.js",
|
||||
"check-similar-keys-exist-in-directory": "node ./scripts/check-similar-keys-exist-in-directory.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.9.1",
|
||||
"@docusaurus/faster": "^3.9.1",
|
||||
"@docusaurus/plugin-css-cascade-layers": "^3.9.1",
|
||||
"@docusaurus/plugin-ideal-image": "^3.9.1",
|
||||
"@docusaurus/plugin-svgr": "^3.9.1",
|
||||
"@docusaurus/plugin-vercel-analytics": "^3.9.1",
|
||||
"@docusaurus/preset-classic": "3.9.1",
|
||||
"@docusaurus/theme-mermaid": "^3.9.1",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"classnames": "^2.3.2",
|
||||
"clsx": "^2.0.0",
|
||||
"marked": "^16.3.0",
|
||||
"prism-react-renderer": "^2.3.0",
|
||||
"prismjs": "^1.29.0",
|
||||
"react": "^19.0.0",
|
||||
"react-dom": "^19.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "3.9.1",
|
||||
"@docusaurus/tsconfig": "3.9.1",
|
||||
"@docusaurus/types": "3.9.1",
|
||||
"typescript": "~5.6.2"
|
||||
},
|
||||
"browserslist": {
|
||||
"production": [
|
||||
">0.5%",
|
||||
"not dead",
|
||||
"not op_mini all"
|
||||
],
|
||||
"development": [
|
||||
"last 3 chrome version",
|
||||
"last 3 firefox version",
|
||||
"last 5 safari version"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=20.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
|
||||
|
||||
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
|
||||
|
||||
/**
|
||||
* Creating a sidebar enables you to:
|
||||
- create an ordered group of docs
|
||||
- render a sidebar for each doc of that group
|
||||
- provide next/previous navigation
|
||||
|
||||
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||
|
||||
Create as many sidebars as you want.
|
||||
*/
|
||||
const sidebars: SidebarsConfig = {
|
||||
// Enhanced sidebar with better organization and features from 3.8+
|
||||
docSidebar: [
|
||||
'about',
|
||||
'getting-started',
|
||||
{
|
||||
type: 'category',
|
||||
label: '🧢 Core',
|
||||
collapsible: true,
|
||||
collapsed: false,
|
||||
items: [
|
||||
{type: 'autogenerated', dirName: 'core'},
|
||||
],
|
||||
},
|
||||
// {
|
||||
// type: 'category',
|
||||
// label: '🔄 Iterator',
|
||||
// collapsible: true,
|
||||
// collapsed: true,
|
||||
// items: [
|
||||
// {type: 'autogenerated', dirName: 'iter'},
|
||||
// ],
|
||||
// },
|
||||
{
|
||||
type: 'category',
|
||||
label: '👣 Mutable',
|
||||
collapsible: true,
|
||||
collapsed: true,
|
||||
items: [
|
||||
{type: 'autogenerated', dirName: 'mutable'},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: '🏎️ Parallel',
|
||||
collapsible: true,
|
||||
collapsed: true,
|
||||
items: [
|
||||
{type: 'autogenerated', dirName: 'parallel'},
|
||||
],
|
||||
},
|
||||
'glossary',
|
||||
],
|
||||
};
|
||||
|
||||
export default sidebars;
|
||||
@@ -0,0 +1,104 @@
|
||||
/**
|
||||
* Any CSS included here will be global. The classic template
|
||||
* bundles Infima by default. Infima is a CSS framework designed to
|
||||
* work well for content-centric websites.
|
||||
*/
|
||||
|
||||
/* Modern CSS cascade layers for better style organization */
|
||||
@layer base, components, utilities;
|
||||
|
||||
/* You can override the default Infima variables here. */
|
||||
/* https://www.colors.tools/lighten-and-darken/ */
|
||||
@layer base {
|
||||
:root {
|
||||
--ifm-color-primary: #007D9C;
|
||||
--ifm-color-primary-dark: #002b36;
|
||||
--ifm-color-primary-darker: #000;
|
||||
--ifm-color-primary-darkest: #000;
|
||||
--ifm-color-primary-light: #03cdff;
|
||||
--ifm-color-primary-lighter: #69e1ff;
|
||||
--ifm-color-primary-lightest: #cff5ff;
|
||||
--ifm-code-font-size: 95%;
|
||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
|
||||
|
||||
--ifm-navbar-background-color: #f9f9f9;
|
||||
--ifm-background-surface-color: #f9f9f9;
|
||||
--ifm-background-surface-color-secondary: #f3f3f3;
|
||||
--ifm-background-color: #ffffff;
|
||||
|
||||
/* --ifm-menu-link-padding-horizontal: 1rem; */
|
||||
}
|
||||
|
||||
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||
[data-theme='dark'] {
|
||||
--ifm-color-primary: #007D9C;
|
||||
--ifm-color-primary-dark: #002b36;
|
||||
--ifm-color-primary-darker: #000;
|
||||
--ifm-color-primary-darkest: #000;
|
||||
--ifm-color-primary-light: #03cdff;
|
||||
--ifm-color-primary-lighter: #69e1ff;
|
||||
--ifm-color-primary-lightest: #cff5ff;
|
||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
|
||||
|
||||
--ifm-background-color: #1f201c;
|
||||
--ifm-background-surface-color: #272822;
|
||||
--ifm-background-surface-color-secondary: #2a2b25;
|
||||
--ifm-navbar-background-color: #272822;
|
||||
}
|
||||
}
|
||||
|
||||
@layer components {
|
||||
.header-github-link:hover {
|
||||
opacity: 0.6;
|
||||
}
|
||||
|
||||
.header-github-link::before {
|
||||
content: '';
|
||||
width: 24px;
|
||||
height: 24px;
|
||||
display: flex;
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
|
||||
[data-theme='dark'] .header-github-link::before {
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
}
|
||||
|
||||
@layer utilities {
|
||||
.theme-doc-sidebar-item-link-level-2 {
|
||||
/* because emojis in the level-1 menu require to push right level-2 menu entries */
|
||||
padding-left: 1.0rem;
|
||||
}
|
||||
}
|
||||
|
||||
/* CUSTOM */
|
||||
.navbar__item .dropdown__menu {
|
||||
min-width: 7rem;
|
||||
}
|
||||
|
||||
.navbar__item .dropdown__menu svg {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* Fix anchor links being hidden behind fixed navbar */
|
||||
html {
|
||||
scroll-padding-top: calc(var(--ifm-navbar-height) + 1rem) !important;
|
||||
}
|
||||
|
||||
/* Also apply scroll-margin-top to specific elements */
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6,
|
||||
[id],
|
||||
.anchor {
|
||||
scroll-margin-top: calc(var(--ifm-navbar-height) + 1rem) !important;
|
||||
}
|
||||
|
||||
/* Target any element that could be an anchor target */
|
||||
*[id] {
|
||||
scroll-margin-top: calc(var(--ifm-navbar-height) + 1rem) !important;
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
.icon {
|
||||
color: var(--ifm-navbar-link-color);
|
||||
font-weight: var(--ifm-font-weight-semibold);
|
||||
padding: var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal);
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.headerImg {
|
||||
padding-top: 20px;
|
||||
height: 180px;
|
||||
}
|
||||
|
||||
.twitter:before {
|
||||
content: '';
|
||||
width: 48px;
|
||||
height: 48px;
|
||||
display: flex;
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
|
||||
html[data-theme='dark'] .twitter:before {
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' fill='white' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
|
||||
.chat:before {
|
||||
content: '';
|
||||
width: 48px;
|
||||
height: 48px;
|
||||
display: flex;
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M21 11.5a8.38 8.38 0 0 1-.9 3.8 8.5 8.5 0 0 1-7.6 4.7 8.38 8.38 0 0 1-3.8-.9L3 21l1.9-5.7a8.38 8.38 0 0 1-.9-3.8 8.5 8.5 0 0 1 4.7-7.6 8.38 8.38 0 0 1 3.8-.9h.5a8.48 8.48 0 0 1 8 8v.5z'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
|
||||
html[data-theme='dark'] .chat:before {
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' fill='white' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M21 11.5a8.38 8.38 0 0 1-.9 3.8 8.5 8.5 0 0 1-7.6 4.7 8.38 8.38 0 0 1-3.8-.9L3 21l1.9-5.7a8.38 8.38 0 0 1-.9-3.8 8.5 8.5 0 0 1 4.7-7.6 8.38 8.38 0 0 1 3.8-.9h.5a8.48 8.48 0 0 1 8 8v.5z'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
|
||||
.email:before {
|
||||
content: '';
|
||||
width: 48px;
|
||||
height: 48px;
|
||||
display: flex;
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M4 4h16c1.1 0 2 .9 2 2v12c0 1.1-.9 2-2 2H4c-1.1 0-2-.9-2-2V6c0-1.1.9-2 2-2z'/%3E%3Cpolyline points='22,6 12,13 2,6'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
|
||||
html[data-theme='dark'] .email:before {
|
||||
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' fill='none' stroke='white' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M4 4h16c1.1 0 2 .9 2 2v12c0 1.1-.9 2-2 2H4c-1.1 0-2-.9-2-2V6c0-1.1.9-2 2-2z'/%3E%3Cpolyline points='22,6 12,13 2,6'/%3E%3C/svg%3E") no-repeat;
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
import React from 'react';
|
||||
|
||||
import styles from './community.module.css';
|
||||
import classnames from 'classnames';
|
||||
import Layout from '@theme/Layout';
|
||||
import Link from '@docusaurus/Link';
|
||||
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
|
||||
function Community() {
|
||||
const context = useDocusaurusContext();
|
||||
|
||||
return (
|
||||
<Layout title="Community" description="Where to ask questions and find your soulmate">
|
||||
<header className="hero">
|
||||
<div className="container text--center">
|
||||
<h1>Community</h1>
|
||||
<div className="hero--subtitle">
|
||||
These are places where you can ask questions and find your soulmate (no promises).
|
||||
</div>
|
||||
<img className={styles.headerImg} src="/img/go-community.png" />
|
||||
</div>
|
||||
</header>
|
||||
<main>
|
||||
<div className="container">
|
||||
<div className="row margin-vert--lg">
|
||||
<div className="col text--center padding-vert--md">
|
||||
<div className="card">
|
||||
<div className="card__header">
|
||||
<i className={classnames(styles.icon, styles.chat)}></i>
|
||||
</div>
|
||||
<div className="card__body">
|
||||
<p>Report bugs or suggest improvements</p>
|
||||
</div>
|
||||
<div className="card__footer">
|
||||
<Link to="https://github.com/samber/lo/issues" className="button button--outline button--primary button--block">Open new issue</Link>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="col text--center padding-vert--md">
|
||||
<div className="card">
|
||||
<div className="card__header">
|
||||
<i className={classnames(styles.icon, styles.chat)}></i>
|
||||
</div>
|
||||
<div className="card__body">
|
||||
<p>You like this project?</p>
|
||||
</div>
|
||||
<div className="card__footer">
|
||||
<Link to="https://github.com/samber/lo?tab=readme-ov-file#-contributing" className="button button--outline button--primary button--block">Start contributing!</Link>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="col text--center padding-vert--md">
|
||||
<div className="card">
|
||||
<div className="card__header">
|
||||
<i className={classnames(styles.icon, styles.twitter)}></i>
|
||||
</div>
|
||||
<div className="card__body">
|
||||
<p>Follow @samuelberthe on Twitter</p>
|
||||
</div>
|
||||
<div className="card__footer">
|
||||
<Link to="https://twitter.com/samuelberthe" className="button button--outline button--primary button--block">Follow @SamuelBerthe</Link>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="col text--center padding-vert--md">
|
||||
<div className="card">
|
||||
<div className="card__header">
|
||||
<i className={classnames(styles.icon, styles.email)}></i>
|
||||
</div>
|
||||
<div className="card__body">
|
||||
<p>For sensitive or security-related queries, send us an email</p>
|
||||
</div>
|
||||
<div className="card__footer">
|
||||
<Link to="mailto:contact@samuel-berthe.fr" className="button button--outline button--primary button--block">contact@samuel-berthe.fr</Link>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
|
||||
export default Community;
|
||||
@@ -0,0 +1,35 @@
|
||||
/**
|
||||
* CSS files with the .module.css suffix will be treated as CSS modules
|
||||
* and scoped locally.
|
||||
*/
|
||||
|
||||
.heroBanner {
|
||||
padding: 4rem 0;
|
||||
text-align: center;
|
||||
position: relative;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 996px) {
|
||||
.heroBanner {
|
||||
padding: 2rem;
|
||||
}
|
||||
}
|
||||
|
||||
.buttons {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.features {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
padding: 2rem 0;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.featureSvg {
|
||||
height: 200px;
|
||||
width: 200px;
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
import type {ReactNode} from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Link from '@docusaurus/Link';
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
import Layout from '@theme/Layout';
|
||||
import Heading from '@theme/Heading';
|
||||
import styles from './index.module.css';
|
||||
|
||||
type FeatureItem = {
|
||||
title: string;
|
||||
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
|
||||
description: ReactNode;
|
||||
};
|
||||
|
||||
const FeatureList: FeatureItem[] = [
|
||||
{
|
||||
title: 'Type-safe Utilities for Go',
|
||||
Svg: require('@site/static/img/oxygen-tube.svg').default,
|
||||
description: (
|
||||
<>
|
||||
Generic utilities bringing type safety and convenience to daily Go programming.
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: 'Comprehensive API Coverage',
|
||||
Svg: require('@site/static/img/compass.svg').default,
|
||||
description: (
|
||||
<>
|
||||
A rich set of helpers for slices, maps, and more, ready for any data task in Go.
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: 'Built for Productivity',
|
||||
Svg: require('@site/static/img/backpacks.svg').default,
|
||||
description: (
|
||||
<>
|
||||
Minimal dependencies and intuitive APIs for seamless adoption and fast results. No breaking changes.
|
||||
</>
|
||||
),
|
||||
},
|
||||
];
|
||||
|
||||
function Feature({title, Svg, description}: FeatureItem) {
|
||||
return (
|
||||
<div className={clsx('col col--4')}>
|
||||
<div className="text--center">
|
||||
<Svg className={styles.featureSvg} role="img" />
|
||||
</div>
|
||||
<div className="text--center padding-horiz--md">
|
||||
<Heading as="h3">{title}</Heading>
|
||||
<p>{description}</p>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function HomepageFeatures(): ReactNode {
|
||||
return (
|
||||
<section className={styles.features}>
|
||||
<div className="container">
|
||||
<div className="row">
|
||||
{FeatureList.map((props, idx) => (
|
||||
<Feature key={idx} {...props} />
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
);
|
||||
}
|
||||
|
||||
function HomepageHeader() {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<header className={clsx('hero hero--primary', styles.heroBanner)}>
|
||||
<div className="container">
|
||||
<Heading as="h1" className="hero__title">
|
||||
{siteConfig.title}
|
||||
</Heading>
|
||||
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||
<div className={styles.buttons} style={{marginBottom: '10px'}}>
|
||||
<Link
|
||||
className="button button--secondary button--lg"
|
||||
to="/docs/about">
|
||||
Intro
|
||||
</Link>
|
||||
</div>
|
||||
<div className={styles.buttons}>
|
||||
<Link
|
||||
className="button button--secondary button--lg"
|
||||
to="/docs/getting-started">
|
||||
Getting started - 5min ⏱️
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
);
|
||||
}
|
||||
|
||||
export default function Home(): JSX.Element {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<Layout
|
||||
title={`🏎️ ${siteConfig.title}: ${siteConfig.tagline}`}
|
||||
description="Reusable utility library for Go">
|
||||
<HomepageHeader />
|
||||
<main>
|
||||
<HomepageFeatures />
|
||||
</main>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
import siteConfig from '@generated/docusaurus.config';
|
||||
export default function prismIncludeLanguages(PrismObject) {
|
||||
const {
|
||||
themeConfig: {prism},
|
||||
} = siteConfig;
|
||||
const {additionalLanguages, defaultLanguage} = prism;
|
||||
|
||||
// Add Go language support
|
||||
globalThis.Prism = PrismObject;
|
||||
|
||||
// eslint-disable-next-line import/no-dynamic-require, global-require
|
||||
require(`prismjs/components/prism-${defaultLanguage}`);
|
||||
|
||||
additionalLanguages.forEach((lang) => {
|
||||
// eslint-disable-next-line import/no-dynamic-require, global-require
|
||||
require(`prismjs/components/prism-${lang}`);
|
||||
});
|
||||
|
||||
delete globalThis.Prism;
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
import React from 'react';
|
||||
import Layout from '@theme/Layout';
|
||||
import Translate, {translate} from '@docusaurus/Translate';
|
||||
import {PageMetadata} from '@docusaurus/theme-common';
|
||||
|
||||
export default function NotFoundPage(): JSX.Element {
|
||||
return (
|
||||
<>
|
||||
<PageMetadata
|
||||
title={translate({
|
||||
id: 'theme.NotFound.title',
|
||||
message: 'Page Not Found',
|
||||
})}
|
||||
/>
|
||||
<Layout>
|
||||
<main className="container margin-vert--xl">
|
||||
<div className="row">
|
||||
<div className="col col--6 col--offset-3">
|
||||
<h1 className="hero__title">
|
||||
<Translate
|
||||
id="theme.NotFound.title"
|
||||
description="The title of the 404 page">
|
||||
Page Not Found
|
||||
</Translate>
|
||||
</h1>
|
||||
<p>
|
||||
<Translate
|
||||
id="theme.NotFound.p1"
|
||||
description="The first paragraph of the 404 page">
|
||||
We could not find what you were looking for.
|
||||
</Translate>
|
||||
</p>
|
||||
<p>
|
||||
<Translate
|
||||
id="theme.NotFound.p2"
|
||||
description="The 2nd paragraph of the 404 page">
|
||||
Please contact the owner of the site that linked you to the
|
||||
original URL and let them know their link is broken.
|
||||
</Translate>
|
||||
</p>
|
||||
<div className="margin-top--lg">
|
||||
<a href="/" className="button button--primary button--lg">
|
||||
<Translate
|
||||
id="theme.NotFound.backToHome"
|
||||
description="The label for the back to home button">
|
||||
Back to Home
|
||||
</Translate>
|
||||
</a>
|
||||
<a href="/docs/getting-started" className="button button--secondary button--lg margin-left--md">
|
||||
<Translate
|
||||
id="theme.NotFound.goDocs"
|
||||
description="The label for the go to docs button">
|
||||
Browse Documentation
|
||||
</Translate>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
</Layout>
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
import siteConfig from '@generated/docusaurus.config';
|
||||
export default function prismIncludeLanguages(PrismObject) {
|
||||
const {
|
||||
themeConfig: {prism},
|
||||
} = siteConfig;
|
||||
const {additionalLanguages, defaultLanguage} = prism;
|
||||
|
||||
// Add Go language support
|
||||
globalThis.Prism = PrismObject;
|
||||
|
||||
// eslint-disable-next-line import/no-dynamic-require, global-require
|
||||
require(`prismjs/components/prism-${defaultLanguage}`);
|
||||
|
||||
additionalLanguages.forEach((lang) => {
|
||||
// eslint-disable-next-line import/no-dynamic-require, global-require
|
||||
require(`prismjs/components/prism-${lang}`);
|
||||
});
|
||||
|
||||
delete globalThis.Prism;
|
||||
}
|
||||
Vendored
Vendored
+3
@@ -0,0 +1,3 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
|
||||
<svg width="800px" height="800px" viewBox="0 0 1024 1024" class="icon" version="1.1" xmlns="http://www.w3.org/2000/svg"><path d="M168.6 694.8h-22.9c-10.3 0-18.7-8.4-18.7-18.7v-44.4c0-10.3 8.4-18.7 18.7-18.7h22.9c10.3 0 18.7 8.4 18.7 18.7v44.4c0 10.2-8.4 18.7-18.7 18.7z" fill="#81B626" /><path d="M188.2 910.7h-62.1c-34.6 0-62.9-28.3-62.9-62.9V734c0-34.6 28.3-62.9 62.9-62.9h62.1c34.6 0 62.9 28.3 62.9 62.9v113.8c0 34.6-28.3 62.9-62.9 62.9z" fill="#98CC46" /><path d="M107.7 850.1V738.9c0-35.3 28.9-64.2 64.2-64.2H208c-6.6-2.3-13.7-3.6-21-3.6h-59.5c-35.3 0-64.2 28.9-64.2 64.2v111.3c0 35.3 28.9 64.2 64.2 64.2h23.4c-25.1-8.9-43.2-32.8-43.2-60.7z" fill="#7EAF2A" /><path d="M308.7 785.8h-87.9c-6.6 0-12-5.4-12-12V665.9c0-6.6 5.4-12 12-12h87.9c6.6 0 12 5.4 12 12v107.9c0 6.6-5.4 12-12 12z" fill="#784D16" /><path d="M629.2 253.8H435.6c-8.6 0-15.5-6.9-15.5-15.5V128.7c0-8.6 6.9-15.5 15.5-15.5h193.6c8.6 0 15.5 6.9 15.5 15.5v109.5c0 8.6-6.9 15.6-15.5 15.6z m-189-112v83.4c0 4.7 3.8 8.5 8.5 8.5h167.5c4.7 0 8.5-3.8 8.5-8.5v-83.4c0-4.7-3.8-8.5-8.5-8.5H448.7c-4.7 0-8.5 3.8-8.5 8.5z" fill="#964F10" /><path d="M785.7 183.5H297.4c-19.5 0-35.5 16-35.5 35.5v690.1h559.3V219c0-19.5-16-35.5-35.5-35.5z" fill="#F1B23B" /><path d="M896.7 407.2h-717c-35.2 0-64.1-28.8-64.1-64.1 0-35.2 28.8-64.1 64.1-64.1h717c35.2 0 64.1 28.8 64.1 64.1-0.1 35.3-28.9 64.1-64.1 64.1z" fill="#F75C2E" /><path d="M542.5 367.1c-175.2 0-330.1-16.8-424.1-42.5-1.8 5.9-2.8 12.1-2.8 18.6 0 35.2 28.8 64.1 64.1 64.1h717c35.2 0 64.1-28.8 64.1-64.1 0-5.7-0.8-11.2-2.2-16.4-94.7 24.4-245.8 40.3-416.1 40.3z" fill="#E7412E" /><path d="M477.9 401l-0.7-0.5V187c0-1.9-2.1-3.5-4.6-3.5H407c-2.5 0-4.6 1.6-4.6 3.5v213.5h0.4l32.1 47.8c1.7 2.5 6.3 2.5 8.1 0.1l34.9-47.4z" fill="#B56B17" /><path d="M402.4 311.9H477V365h-74.6z" fill="#2B2B2B" /><path d="M468.9 356.6h-62.1c-9.5 0-17.2-7.7-17.2-17.2s7.7-17.2 17.2-17.2h62.1c9.5 0 17.2 7.7 17.2 17.2 0 9.4-7.8 17.2-17.2 17.2z" fill="#F8E9CC" /><path d="M470.8 338.4h-18c-3.4 0-6.2-2.8-6.2-6.2 0-3.4 2.8-6.2 6.2-6.2h18c3.4 0 6.2 2.8 6.2 6.2 0 3.4-2.8 6.2-6.2 6.2z" fill="#FDFCF8" /><path d="M674.8 407.3l-0.7-0.5V187.1c0-2-2.1-3.6-4.6-3.6H604c-2.5 0-4.6 1.6-4.6 3.6v219.6h0.4l32.1 49.2c1.7 2.5 6.3 2.6 8.1 0.1l34.8-48.7z" fill="#B56B17" /><path d="M599.8 311.9h74.6V365h-74.6z" fill="#2B2B2B" /><path d="M668.2 356.6H606c-9.5 0-17.2-7.7-17.2-17.2s7.7-17.2 17.2-17.2h62.1c9.5 0 17.2 7.7 17.2 17.2 0.1 9.4-7.7 17.2-17.1 17.2z" fill="#F8E9CC" /><path d="M671.2 338.4h-18c-3.4 0-6.2-2.8-6.2-6.2 0-3.4 2.8-6.2 6.2-6.2h18c3.4 0 6.2 2.8 6.2 6.2 0 3.4-2.8 6.2-6.2 6.2z" fill="#FDFCF8" /><path d="M524.9 831.7H355.4c-9.1 0-16.6-7.5-16.6-16.6V654.2c0-9.1 7.5-16.6 16.6-16.6h169.5c9.1 0 16.6 7.5 16.6 16.6v160.9c0 9.2-7.5 16.6-16.6 16.6z" fill="#A87A2A" /><path d="M524.9 637.6H355.4c-9.1 0-16.6 7.5-16.6 16.6v50.3h202.7v-50.3c0-9.1-7.5-16.6-16.6-16.6z" fill="#7F520F" /><path d="M461.2 730.6l-0.4-0.2v-91.2c0-0.8-1.2-1.5-2.6-1.5h-37.4c-1.4 0-2.6 0.7-2.6 1.5v91.2h0.2l18.3 20.4c1 1.1 3.6 1.1 4.6 0l19.9-20.2z" fill="#B56B17" /><path d="M727.6 727.7H598.8c-6.6 0-12-5.4-12-12V641c0-6.6 5.4-12 12-12h128.8c6.6 0 12 5.4 12 12v74.7c0 6.6-5.4 12-12 12z" fill="#848484" /><path d="M610.2 629h18.7v98.7h-18.7zM679 629h18.7v98.7H679z" fill="#474747" /><path d="M617 578v261.1H424.4l110-261.1z" fill="#999999" /><path d="M621.3 910.8h-210c-4.2 0-7.7-3.4-7.7-7.7v-56.3c0-4.2 3.4-7.7 7.7-7.7h209.9c4.2 0 7.7 3.5 7.7 7.7v56.3c0 4.2-3.4 7.7-7.6 7.7zM625.2 578h-96c-3.4 0-6.1-2.8-6.1-6.1v-26c0-3.4 2.8-6.1 6.1-6.1h96c3.4 0 6.1 2.8 6.1 6.1v26c0 3.4-2.8 6.1-6.1 6.1z" fill="#515151" /><path d="M691 578v261.1h192.6L773.5 578z" fill="#999999" /><path d="M686.7 910.8h209.9c4.2 0 7.7-3.4 7.7-7.7v-56.3c0-4.2-3.5-7.7-7.7-7.7H686.7c-4.2 0-7.7 3.5-7.7 7.7v56.3c0 4.2 3.5 7.7 7.7 7.7zM682.8 578h96c3.4 0 6.1-2.8 6.1-6.1v-26c0-3.4-2.8-6.1-6.1-6.1h-96c-3.4 0-6.1 2.8-6.1 6.1v26c0 3.4 2.7 6.1 6.1 6.1z" fill="#515151" /><path d="M851.3 820.4c-5.4 2.2-11.6-0.4-13.8-5.7l-87.8-212.8c-2.2-5.4 0.4-11.6 5.7-13.8 5.4-2.2 11.6 0.4 13.8 5.7L857 806.6c2.3 5.3-0.3 11.6-5.7 13.8zM592 813.4c5.7 0 10.4-4.7 10.4-10.4V600.4c0-5.7-4.7-10.4-10.4-10.4s-10.4 4.7-10.4 10.4V803c0 5.7 4.7 10.4 10.4 10.4z" fill="#DDDDDD" /><path d="M886.3 884.3c-5.7 0-10.4-4.7-10.4-10.4v-10.7c0-5.7 4.7-10.4 10.4-10.4s10.4 4.7 10.4 10.4v10.7c0.1 5.7-4.6 10.4-10.4 10.4zM610.2 884.3c-5.7 0-10.4-4.7-10.4-10.4v-10.7c0-5.7 4.7-10.4 10.4-10.4s10.4 4.7 10.4 10.4v10.7c0.1 5.7-4.6 10.4-10.4 10.4z" fill="#E2E2E2" /><path d="M208.8 734.7h53.1v174.5h-53.1z" fill="#A87A2A" /><path d="M186.8 799.5c-6.2 0-11.2-5.1-11.2-11.2V713c0-6.2 5.1-11.2 11.2-11.2 6.2 0 11.2 5.1 11.2 11.2v75.3c0 6.1-5 11.2-11.2 11.2zM168.8 645.9c-4.6 0-8.4-3.8-8.4-8.4v-6.8c0-4.6 3.8-8.4 8.4-8.4 4.6 0 8.4 3.8 8.4 8.4v6.8c0 4.6-3.8 8.4-8.4 8.4z" fill="#ECF5D5" /></svg>
|
||||
|
After Width: | Height: | Size: 4.8 KiB |
Vendored
+3
@@ -0,0 +1,3 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
|
||||
<svg width="800px" height="800px" viewBox="0 0 1024 1024" class="icon" version="1.1" xmlns="http://www.w3.org/2000/svg"><path d="M512 198.7c-33 0-59.9-26.9-59.9-59.9v-14.3c0-33 26.9-59.9 59.9-59.9s59.9 26.9 59.9 59.9v14.3c-0.1 33-26.9 59.9-59.9 59.9zM512 75c-27.3 0-49.5 22.2-49.5 49.5v14.3c0 27.3 22.2 49.5 49.5 49.5s49.5-22.2 49.5-49.5v-14.3C561.4 97.2 539.2 75 512 75z" fill="#986612" /><path d="M515.5 289.5h-5.8c-24.2 0-43.9-19.8-43.9-43.9v-71.8c0-24.2 19.8-43.9 43.9-43.9h5.8c24.2 0 43.9 19.8 43.9 43.9v71.8c0.1 24.1-19.7 43.9-43.9 43.9z" fill="#D8962A" /><path d="M512.6 584.5m-374.9 0a374.9 374.9 0 1 0 749.8 0 374.9 374.9 0 1 0-749.8 0Z" fill="#F6B13A" /><path d="M512.6 584.5m-309.1 0a309.1 309.1 0 1 0 618.2 0 309.1 309.1 0 1 0-618.2 0Z" fill="#F35426" /><path d="M512.6 584.5m-249.7 0a249.7 249.7 0 1 0 499.4 0 249.7 249.7 0 1 0-499.4 0Z" fill="#F4F4F4" /><path d="M313.3 584.5h-95.5c-7.6 0-13.9-6.2-13.9-13.9 0-7.6 6.2-13.9 13.9-13.9h95.5c7.6 0 13.9 6.2 13.9 13.9-0.1 7.7-6.3 13.9-13.9 13.9zM525.9 774.6V870c0 7.6-6.2 13.9-13.9 13.9-7.6 0-13.9-6.2-13.9-13.9v-95.5c0-7.6 6.2-13.9 13.9-13.9 7.6 0.1 13.9 6.3 13.9 14zM525.9 297.3v95.5c0 7.6-6.2 13.9-13.9 13.9-7.6 0-13.9-6.2-13.9-13.9v-95.5c0-7.6 6.2-13.9 13.9-13.9 7.6 0 13.9 6.3 13.9 13.9zM810 584.5h-95.5c-7.6 0-13.9-6.2-13.9-13.9 0-7.6 6.2-13.9 13.9-13.9H810c7.6 0 13.9 6.2 13.9 13.9s-6.2 13.9-13.9 13.9z" fill="#C9CCC7" /><path d="M484.3 624l-128-135.1 179.2 52.8z" fill="#EC5C3D" /><path d="M483.9 623.8l178.5 52.4-128.6-135.5z" fill="#2E9DC7" /></svg>
|
||||
|
After Width: | Height: | Size: 1.6 KiB |
Vendored
+2145
File diff suppressed because one or more lines are too long
Vendored
BIN
Binary file not shown.
|
After Width: | Height: | Size: 5.6 KiB |
Vendored
BIN
Binary file not shown.
|
After Width: | Height: | Size: 872 KiB |
Vendored
BIN
Binary file not shown.
|
After Width: | Height: | Size: 5.6 KiB |
Vendored
+3
@@ -0,0 +1,3 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
|
||||
<svg width="800px" height="800px" viewBox="0 0 1024 1024" class="icon" version="1.1" xmlns="http://www.w3.org/2000/svg"><path d="M459.5 272.1c-2.5 0-5.1-0.3-7.6-0.8L360 252.9c-10.1-2-18.8-7.9-24.6-16.5-5.7-8.6-7.8-18.9-5.8-29l16.6-82.7c3.6-18 19.6-31.1 38-31.1 2.5 0 5.1 0.3 7.6 0.8l91.9 18.4c20.9 4.2 34.5 24.6 30.3 45.5L497.5 241c-3.6 18-19.6 31.1-38 31.1z m-75.2-165.2c-12.1 0-22.5 8.6-24.9 20.4L342.8 210c-1.3 6.6 0 13.4 3.8 19 3.8 5.7 9.5 9.5 16.1 10.8l91.9 18.4c1.6 0.3 3.3 0.5 5 0.5 12.1 0 22.5-8.6 24.9-20.4l16.6-82.7c2.7-13.7-6.2-27.1-19.9-29.8l-91.9-18.4c-1.7-0.3-3.4-0.5-5-0.5zM578 272.1c-18.4 0-34.4-13.1-38-31.1l-16.6-82.7c-4.2-20.9 9.4-41.3 30.3-45.5l91.9-18.4c2.5-0.5 5-0.8 7.6-0.8 18.4 0 34.4 13.1 38 31.1l16.6 82.7c2 10.1 0 20.4-5.8 29-5.7 8.6-14.5 14.5-24.6 16.5l-91.9 18.4c-2.5 0.5-5 0.8-7.5 0.8z m75.2-165.2c-1.7 0-3.3 0.2-5 0.5l-91.9 18.4c-13.7 2.7-22.6 16.1-19.9 29.8l16.6 82.7c2.4 11.8 12.8 20.4 24.9 20.4 1.7 0 3.3-0.2 5-0.5l91.9-18.4c6.6-1.3 12.3-5.2 16.1-10.8 3.8-5.7 5.1-12.4 3.8-19l-16.6-82.7c-2.4-11.8-12.8-20.4-24.9-20.4z" fill="#144663" /><path d="M515.6 128.2m-62.3 0a62.3 62.3 0 1 0 124.6 0 62.3 62.3 0 1 0-124.6 0Z" fill="#A5D2E0" /><path d="M515.6 152.2c-13.2 0-24-10.8-24-24s10.8-24 24-24 24 10.8 24 24-10.8 24-24 24z" fill="#15536D" /><path d="M529.3 109.1m-19.1 0a19.1 19.1 0 1 0 38.2 0 19.1 19.1 0 1 0-38.2 0Z" fill="#FFFFFF" /><path d="M375.9 277.7h-62.3c-13.2 0-24-10.8-24-24V211c0-13.2 10.8-24 24-24h62.3c13.2 0 24 10.8 24 24v42.7c0 13.2-10.8 24-24 24z" fill="#1C8BBC" /><path d="M354.6 958.1h-16c-63.1 0-114.7-51.6-114.7-114.7V347c0-63.1 51.6-114.7 114.7-114.7h16c63.1 0 114.7 51.6 114.7 114.7v496.3c0 63.1-51.6 114.8-114.7 114.8z" fill="#25A0C8" /><path d="M425.7 884.7c-7.3 0-13.3-6-13.3-13.3V343.9c0-7.3 6-13.3 13.3-13.3 7.3 0 13.3 6 13.3 13.3v527.4c0.1 7.4-5.9 13.4-13.3 13.4z" fill="#C8E3EB" /><path d="M472.4 391.6H217.2c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12zM472.4 436.4H217.2c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12zM472.4 812.9H217.2c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12zM472.4 857.7H217.2c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12z" fill="#15749A" /><path d="M710.3 277.7H648c-13.2 0-24-10.8-24-24V211c0-13.2 10.8-24 24-24h62.3c13.2 0 24 10.8 24 24v42.7c0.1 13.2-10.8 24-24 24z" fill="#1C8BBC" /><path d="M689 958.1h-16c-63.1 0-114.7-51.6-114.7-114.7V347c0-63.1 51.6-114.7 114.7-114.7h16c63.1 0 114.7 51.6 114.7 114.7v496.3c0 63.1-51.6 114.8-114.7 114.8z" fill="#25A0C8" /><path d="M760.1 884.7c-7.3 0-13.3-6-13.3-13.3V343.9c0-7.3 6-13.3 13.3-13.3 7.3 0 13.3 6 13.3 13.3v527.4c0.1 7.4-5.9 13.4-13.3 13.4z" fill="#C8E3EB" /><path d="M806.8 391.6H551.6c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12zM806.8 436.4H551.6c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12zM806.8 812.9H551.6c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12zM806.8 857.7H551.6c-6.6 0-12-5.4-12-12s5.4-12 12-12h255.3c6.6 0 12 5.4 12 12-0.1 6.6-5.5 12-12.1 12z" fill="#15749A" /></svg>
|
||||
|
After Width: | Height: | Size: 3.2 KiB |
Vendored
+515
@@ -0,0 +1,515 @@
|
||||
# Lo - A Go library for functional programming
|
||||
|
||||
Lo is a comprehensive, production-ready Lodash-style Go library built on Go 1.18+ generics that provides hundreds of utility functions for working with slices, maps, strings, channels, functions, and more. It aims to make Go code more expressive, readable, and productive by offering a rich collection of functional programming helpers inspired by libraries like Lodash in JavaScript.
|
||||
|
||||
## Origins and Purpose
|
||||
|
||||
Born from the need to fill gaps in Go's standard library after the introduction of generics in Go 1.18, Lo addresses common pain points that Go developers face daily. While Go's standard library gained some generic helpers in `slices` and `maps` packages, Lo goes far beyond with 300+ carefully crafted utilities that make functional programming patterns natural and idiomatic in Go.
|
||||
|
||||
The library emerged from real-world production needs and has been battle-tested in numerous high-traffic applications, microservices, and enterprise systems. It's not just a collection of utility functions, but a thoughtful toolkit that enables developers to write more declarative, maintainable, and bug-free code.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Generic-based**: Fully leverages Go 1.18+ generics for compile-time type safety
|
||||
- **Zero dependencies**: No external dependencies outside the Go standard library
|
||||
- **Comprehensive**: 300+ helpers covering slices, maps, strings, channels, functions, and more
|
||||
- **Functional programming**: Brings functional programming paradigms to Go naturally
|
||||
- **Production-ready**: Battle-tested in high-traffic applications worldwide
|
||||
- **Well-tested**: 95%+ test coverage with comprehensive examples
|
||||
- **SemVer compliant**: Follows strict semantic versioning (v1.x.x stable)
|
||||
- **Performance-focused**: Minimal runtime overhead with optimized implementations
|
||||
- **Memory efficient**: Many helpers avoid allocations and use zero-copy patterns
|
||||
- **Composable**: Designed to work together in method chains and complex pipelines
|
||||
|
||||
## Sub-packages
|
||||
|
||||
The main package is complemented by several specialized sub-packages:
|
||||
|
||||
- **lo**: Core package with 300+ helpers for everyday operations
|
||||
- **lo/parallel**: Parallel processing helpers for concurrent operations
|
||||
- **lo/mutable**: In-place mutation helpers for memory-efficient operations
|
||||
- **lo/it**: Iterator helpers for lazy evaluation and streaming
|
||||
|
||||
## Design Philosophy
|
||||
|
||||
Lo is built on a foundation of pragmatic engineering principles that balance power, safety, and performance:
|
||||
|
||||
1. **Type Safety First**: All helpers leverage Go's generics for compile-time type checking, eliminating runtime type assertions and reducing bugs
|
||||
2. **Go Idiomatic**: While inspired by functional programming, helpers feel natural in Go code and follow established conventions
|
||||
3. **Performance Conscious**: Every helper is benchmarked and optimized for minimal overhead, with many using zero-copy patterns
|
||||
4. **Explicit Clarity**: Helper names clearly communicate their purpose and behavior
|
||||
5. **Composable by Design**: Functions work together seamlessly, enabling elegant data transformation pipelines
|
||||
6. **Memory Efficient**: Careful attention to allocation patterns, with many helpers avoiding unnecessary heap allocations
|
||||
7. **Error Handling Respect**: Helpers don't hide errors; they integrate naturally with Go's error handling patterns
|
||||
8. **Practical Over Pure**: Prioritizes solving real-world problems over theoretical purity
|
||||
|
||||
## Root Package Helpers
|
||||
|
||||
### Condition
|
||||
- If: Conditional statement that returns a value
|
||||
- IfF: Conditional statement with function execution
|
||||
- Switch: Switch statement that returns a value
|
||||
- Ternary: Ternary operator
|
||||
- TernaryF: Ternary operator with function execution
|
||||
|
||||
### Concurrency
|
||||
- Async: Execute function asynchronously
|
||||
- Async0-Async6: Execute functions with 0-6 return values asynchronously
|
||||
- Synchronize: Synchronize goroutines
|
||||
- WaitFor: Wait for condition to be true
|
||||
- WaitForWithContext: Wait for condition with context
|
||||
|
||||
### Error Handling
|
||||
- Validate: Validate condition and return error
|
||||
- Must0-Must6: Must helpers with 0-6 return values
|
||||
- Try0-Try6: Try helpers with 0-6 return values
|
||||
- TryOr: Try with fallback value
|
||||
- TryOr1-TryOr6: Try with fallback values
|
||||
- TryWithErrorValue: Try with error value
|
||||
- TryCatch: Try-catch block
|
||||
- TryCatchWithErrorValue: Try-catch with error value
|
||||
- ErrorsAs: Convert errors
|
||||
- Assert: Assert condition
|
||||
- Assertf: Assert condition with formatting
|
||||
|
||||
### Find
|
||||
- Find: Find element in collection
|
||||
- FindOrElse: Find element or return fallback
|
||||
- FindIndexOf: Find element and its index
|
||||
- FindLastIndexOf: Find last occurrence and its index
|
||||
- FindKey: Find key in map by value
|
||||
- FindKeyBy: Find key by predicate
|
||||
- FindUniques: Find unique elements
|
||||
- FindUniquesBy: Find unique elements by predicate
|
||||
- FindDuplicates: Find duplicate elements
|
||||
- FindDuplicatesBy: Find duplicates by predicate
|
||||
- First: Get first element
|
||||
- FirstOr: Get first element or fallback
|
||||
- FirstOrEmpty: Get first element or empty value
|
||||
- Last: Get last element
|
||||
- LastOr: Get last element or fallback
|
||||
- LastOrEmpty: Get last element or empty value
|
||||
- Nth: Get nth element
|
||||
- NthOr: Get nth element or fallback
|
||||
- NthOrEmpty: Get nth element or empty value
|
||||
- Sample: Sample random element
|
||||
- SampleBy: Sample by predicate
|
||||
- Samples: Sample multiple elements
|
||||
- SamplesBy: Sample multiple by predicate
|
||||
- Min: Find minimum value
|
||||
- MinBy: Find minimum by predicate
|
||||
- MinIndex: Find minimum index
|
||||
- MinIndexBy: Find minimum index by predicate
|
||||
- Max: Find maximum value
|
||||
- MaxBy: Find maximum by predicate
|
||||
- MaxIndex: Find maximum index
|
||||
- MaxIndexBy: Find maximum index by predicate
|
||||
- Earliest: Find earliest time
|
||||
- EarliestBy: Find earliest by predicate
|
||||
- Latest: Find latest time
|
||||
- LatestBy: Find latest by predicate
|
||||
|
||||
### Function
|
||||
- Partial: Create partial function
|
||||
- Partial1-Partial5: Create partial functions with 1-5 arguments
|
||||
- NewDebounce: Create debounced function
|
||||
- NewDebounceBy: Create debounced function by key
|
||||
- NewThrottle: Create throttled function
|
||||
- NewThrottleBy: Create throttled function by key
|
||||
- NewThrottleWithCount: Create throttled function with count
|
||||
- NewThrottleByWithCount: Create throttled function by key with count
|
||||
- NewTransaction: Create transaction
|
||||
- Duration: Measure execution duration
|
||||
- Duration0-Duration10: Measure duration with 0-10 return values
|
||||
|
||||
### Intersect
|
||||
- Intersect: Find intersection of collections
|
||||
- Difference: Find difference between collections
|
||||
- Union: Find union of collections
|
||||
- ElementsMatch: Check if elements match
|
||||
- ElementsMatchBy: Check if elements match by predicate
|
||||
- Contains: Check if collection contains element
|
||||
- ContainsBy: Check if collection contains by predicate
|
||||
- HasPrefix: Check if collection has prefix
|
||||
- HasSuffix: Check if collection has suffix
|
||||
- Some: Check if collection contains some elements
|
||||
- SomeBy: Check if collection contains some by predicate
|
||||
- Every: Check if collection contains all elements
|
||||
- EveryBy: Check if collection contains all by predicate
|
||||
- None: Check if collection contains none
|
||||
- NoneBy: Check if collection contains none by predicate
|
||||
- IndexOf: Find index of element
|
||||
- LastIndexOf: Find last index of element
|
||||
|
||||
### Map
|
||||
- Map: Apply function to collection
|
||||
- MapValues: Apply function to map values
|
||||
- MapKeys: Apply function to map keys
|
||||
- MapEntries: Apply function to map entries
|
||||
- MapToSlice: Convert map to slice
|
||||
- FilterMapToSlice: Filter and map to slice
|
||||
- FlatMap: Apply function and flatten
|
||||
- FilterMap: Filter and map
|
||||
- RejectMap: Reject and map
|
||||
|
||||
### Math
|
||||
- Range: Generate range of numbers
|
||||
- RangeFrom: Generate range from start
|
||||
- RangeWithSteps: Generate range with steps
|
||||
- Clamp: Clamp value between min and max
|
||||
- Sum: Sum numbers
|
||||
- SumBy: Sum by predicate
|
||||
- Product: Product of numbers
|
||||
- ProductBy: Product by predicate
|
||||
- Mean: Mean of numbers
|
||||
- MeanBy: Mean by predicate
|
||||
- Mode: Mode of numbers
|
||||
|
||||
### Retry
|
||||
- Attempt: Attempt operation with retries
|
||||
- AttemptWhile: Attempt while condition
|
||||
- AttemptWithDelay: Attempt with delay
|
||||
- AttemptWhileWithDelay: Attempt while with delay
|
||||
|
||||
### Slice
|
||||
- Chunk: Split slice into chunks
|
||||
- ChunkString: Split string into chunks
|
||||
- Drop: Drop first n elements
|
||||
- DropRight: Drop last n elements
|
||||
- DropWhile: Drop while condition
|
||||
- DropRightWhile: Drop right while condition
|
||||
- DropByIndex: Drop elements by index
|
||||
- Filter: Filter collection
|
||||
- FilterReject: Filter and reject
|
||||
- Reject: Reject elements
|
||||
- Compact: Compact collection
|
||||
- Fill: Fill collection
|
||||
- ForEach: Apply function to each element
|
||||
- ForEachWhile: Apply function while condition
|
||||
- GroupBy: Group elements by key
|
||||
- GroupByMap: Group elements by key to map
|
||||
- PartitionBy: Partition elements by predicate
|
||||
- Count: Count elements
|
||||
- CountBy: Count by predicate
|
||||
- CountValues: Count values
|
||||
- CountValuesBy: Count values by predicate
|
||||
- Reduce: Reduce collection
|
||||
- ReduceRight: Reduce from right
|
||||
- Repeat: Repeat element
|
||||
- RepeatBy: Repeat by predicate
|
||||
- Times: Call function n times
|
||||
- Replace: Replace elements
|
||||
- ReplaceAll: Replace all elements
|
||||
- Reverse: Reverse collection
|
||||
- Slice: Slice collection
|
||||
- Splice: Splice collection
|
||||
- Subset: Get subset of collection
|
||||
- Shuffle: Shuffle collection
|
||||
- Uniq: Get unique elements
|
||||
- UniqBy: Get unique by predicate
|
||||
- Without: Remove elements
|
||||
- WithoutBy: Remove elements by predicate
|
||||
- WithoutNth: Remove nth element
|
||||
- WithoutEmpty: Remove empty elements
|
||||
- IsSorted: Check if collection is sorted
|
||||
- IsSortedByKey: Check if sorted by key
|
||||
- Interleave: Interleave collections
|
||||
|
||||
### String
|
||||
- Substring: Get substring
|
||||
- CamelCase: Convert to camel case
|
||||
- PascalCase: Convert to pascal case
|
||||
- KebabCase: Convert to kebab case
|
||||
- SnakeCase: Convert to snake case
|
||||
- Capitalize: Capitalize string
|
||||
- Words: Split string into words
|
||||
- Ellipsis: Truncate string with ellipsis
|
||||
- Elipse: Alias for Ellipsis
|
||||
- RandomString: Generate random string
|
||||
- RuneLength: Get rune length
|
||||
- Trim: Trim string
|
||||
- TrimLeft: Trim left
|
||||
- TrimRight: Trim right
|
||||
- TrimPrefix: Trim prefix
|
||||
- TrimSuffix: Trim suffix
|
||||
- Cut: Cut string at separator
|
||||
- CutPrefix: Cut prefix from string
|
||||
- CutSuffix: Cut suffix from string
|
||||
|
||||
### Time
|
||||
- Duration: Measure duration
|
||||
- Duration0-Duration10: Measure duration with return values
|
||||
- WaitFor: Wait for condition
|
||||
- WaitForWithContext: Wait for condition with context
|
||||
- Earliest: Find earliest time
|
||||
- EarliestBy: Find earliest by predicate
|
||||
- Latest: Find latest time
|
||||
- LatestBy: Find latest by predicate
|
||||
|
||||
### Tuple
|
||||
- T2-T9: Create tuples with 2-9 elements
|
||||
- Unzip2-Unzip9: Unzip tuples with 2-9 elements
|
||||
- UnzipBy2-UnzipBy9: Unzip by predicate with 2-9 elements
|
||||
- Zip2-Zip9: Zip collections with 2-9 elements
|
||||
- ZipBy2-ZipBy9: Zip by predicate with 2-9 elements
|
||||
- CrossJoin2-CrossJoin9: Cross join with 2-9 collections
|
||||
- CrossJoinBy2-CrossJoinBy9: Cross join by predicate with 2-9 collections
|
||||
|
||||
### Type
|
||||
- KeyBy: Key collection by field
|
||||
- Keys: Get keys from map
|
||||
- Values: Get values from map
|
||||
- Entries: Get entries from map
|
||||
- FromEntries: Create map from entries
|
||||
- ToPairs: Convert map to pairs
|
||||
- FromPairs: Create map from pairs
|
||||
- HasKey: Check if map has key
|
||||
- PickBy: Pick by predicate
|
||||
- PickByKeys: Pick by keys
|
||||
- PickByValues: Pick by values
|
||||
- OmitBy: Omit by predicate
|
||||
- OmitByKeys: Omit by keys
|
||||
- OmitByValues: Omit by values
|
||||
- Invert: Invert map
|
||||
- Assign: Assign maps
|
||||
- ChunkEntries: Split map entries into chunks
|
||||
- Associate: Create map from collection
|
||||
- SliceToMap: Convert slice to map
|
||||
- FilterSliceToMap: Filter and convert slice to map
|
||||
- ValueOr: Get value or fallback
|
||||
- Keyify: Create set from collection
|
||||
- Empty: Get empty value
|
||||
- IsEmpty: Check if value is empty
|
||||
- IsNotEmpty: Check if value is not empty
|
||||
- Coalesce: Return first non-empty value
|
||||
- CoalesceOrEmpty: Return first non-empty or empty
|
||||
- CoalesceSlice: Return first non-empty slice
|
||||
- CoalesceSliceOrEmpty: Return first non-empty slice or empty
|
||||
- CoalesceMap: Return first non-empty map
|
||||
- CoalesceMapOrEmpty: Return first non-empty map or empty
|
||||
- ToPtr: Convert to pointer
|
||||
- FromPtr: Convert from pointer
|
||||
- FromPtrOr: Convert from pointer or fallback
|
||||
- ToSlicePtr: Convert slice to pointer slice
|
||||
- FromSlicePtr: Convert pointer slice to slice
|
||||
- FromSlicePtrOr: Convert pointer slice or fallback
|
||||
- ToAnySlice: Convert to any slice
|
||||
- FromAnySlice: Convert from any slice
|
||||
- IsNil: Check if nil
|
||||
- IsNotNil: Check if not nil
|
||||
- Nil: Return nil pointer
|
||||
- EmptyableToPtr: Convert emptyable to pointer
|
||||
- Validate: Validate condition
|
||||
|
||||
### Channel
|
||||
- ChannelToSlice: Convert channel to slice
|
||||
- SliceToChannel: Convert slice to channel
|
||||
- Batch: Batch channel values
|
||||
- BatchWithTimeout: Batch with timeout
|
||||
- Buffer: Buffer channel values
|
||||
- BufferWithTimeout: Buffer with timeout
|
||||
- BufferWithContext: Buffer with context
|
||||
- ChannelMerge: Merge channels
|
||||
- ChannelDispatcher: Dispatch to multiple channels
|
||||
- FanIn: Fan in channels
|
||||
- FanOut: Fan out channels
|
||||
- Generator: Generate channel values
|
||||
- DispatchingStrategyFirst: First dispatch strategy
|
||||
- DispatchingStrategyLeast: Least dispatch strategy
|
||||
- DispatchingStrategyMost: Most dispatch strategy
|
||||
- DispatchingStrategyRandom: Random dispatch strategy
|
||||
- DispatchingStrategyRoundRobin: Round robin dispatch strategy
|
||||
- DispatchingStrategyWeightedRandom: Weighted random dispatch strategy
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- **Documentation**: Comprehensive documentation with examples for every helper
|
||||
- **GoDoc**: https://pkg.go.dev/github.com/samber/lo
|
||||
- **GitHub**: https://github.com/samber/lo
|
||||
- **Playground**: Every helper includes a Go Playground example for quick testing
|
||||
- **Community**: Active community with contributions from hundreds of developers
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Collection Operations
|
||||
|
||||
```go
|
||||
import "github.com/samber/lo"
|
||||
|
||||
// Remove duplicates from a slice
|
||||
names := lo.Uniq([]string{"Samuel", "John", "Samuel"})
|
||||
// []string{"Samuel", "John"}
|
||||
|
||||
// Filter and transform in one operation
|
||||
numbers := lo.FilterMap([]int{1, 2, 3, 4, 5}, func(item int, index int) (string, bool) {
|
||||
if item%2 == 0 {
|
||||
return fmt.Sprintf("even-%d", item), true
|
||||
}
|
||||
return "", false
|
||||
})
|
||||
// []string{"even-2", "even-4"}
|
||||
```
|
||||
|
||||
### Advanced Data Processing
|
||||
|
||||
```go
|
||||
// Complex data transformation pipeline
|
||||
users := []User{{ID: 1, Name: "Alice", Active: true}, {ID: 2, Name: "Bob", Active: false}}
|
||||
|
||||
// Group active users by name length, then extract IDs
|
||||
activeUserIDs := lo.Pipe(
|
||||
users,
|
||||
lo.Filter(func(u User) bool { return u.Active }),
|
||||
lo.GroupBy(func(u User) int { return len(u.Name) }),
|
||||
lo.MapValues(func(users []User) []int {
|
||||
return lo.Map(users, func(u User) int { return u.ID })
|
||||
}),
|
||||
)
|
||||
// map[int][]int{5: []int{1}}
|
||||
|
||||
// Safe nested data access
|
||||
config := map[string]any{
|
||||
"database": map[string]any{
|
||||
"host": "localhost",
|
||||
"port": 5432,
|
||||
},
|
||||
}
|
||||
|
||||
host := lo.ValueOr(lo.CoalesceMap(
|
||||
lo.MapValues(config, func(v any) map[string]any {
|
||||
if m, ok := v.(map[string]any); ok {
|
||||
return m
|
||||
}
|
||||
return nil
|
||||
}),
|
||||
), "localhost")
|
||||
```
|
||||
|
||||
### Concurrency and Async Operations
|
||||
|
||||
```go
|
||||
// Parallel processing of large datasets
|
||||
results := lop.Map(items, func(item Item) Result {
|
||||
return processItem(item) // Executed in parallel
|
||||
})
|
||||
|
||||
// Debounce API calls to avoid rate limiting
|
||||
debouncedSearch := lo.NewDebounce(300*time.Millisecond, func() {
|
||||
results := searchAPI(query)
|
||||
updateUI(results)
|
||||
})
|
||||
|
||||
// Safe error handling with fallbacks
|
||||
result, ok := lo.TryOr(func() (int, error) {
|
||||
return dangerousOperation()
|
||||
}, 0)
|
||||
```
|
||||
|
||||
### Functional Control Flow
|
||||
|
||||
```go
|
||||
// Elegant conditional logic
|
||||
message := lo.If(user != nil, "Welcome back!").
|
||||
ElseIfF(isGuest, func() string { return "Welcome guest!" }).
|
||||
Else("Please login")
|
||||
|
||||
// Retry logic with exponential backoff
|
||||
result, err := lo.AttemptWithDelay(3, time.Second, func(i int, d time.Duration) error {
|
||||
return callExternalAPI(context.Background())
|
||||
})
|
||||
|
||||
// Transaction management
|
||||
tx := lo.NewTransaction[Order]()
|
||||
defer tx.Rollback()
|
||||
|
||||
order, err := tx.Run(func() (Order, error) {
|
||||
inventory := checkInventory(items)
|
||||
if !inventory.Available {
|
||||
return Order{}, errors.New("insufficient inventory")
|
||||
}
|
||||
return createOrder(user, items)
|
||||
})
|
||||
```
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
Lo is engineered for performance-critical applications with several optimization strategies:
|
||||
|
||||
### Memory Efficiency
|
||||
- **Zero-copy patterns**: Many helpers avoid unnecessary allocations by working with existing data
|
||||
- **Slice reuse**: Mutable variants (`lo/mutable`) enable in-place operations for memory-constrained environments
|
||||
- **Lazy evaluation**: Iterator patterns in `lo/iter` support streaming of large datasets
|
||||
- **Pre-allocation**: Collection sizes are pre-calculated when possible to minimize reallocations
|
||||
|
||||
### Performance Characteristics
|
||||
- **Compile-time optimization**: Generic types enable compile-time specialization and optimization
|
||||
- **Minimal overhead**: Most helpers add zero or single-digit nanosecond overhead
|
||||
- **Cache-friendly**: Linear memory access patterns for better CPU cache utilization
|
||||
- **Branch prediction**: Hot paths are optimized for common case execution
|
||||
|
||||
### Benchmarks and Optimization
|
||||
Every helper includes comprehensive benchmarks covering:
|
||||
- Different input sizes (small, medium, large)
|
||||
- Various data types (int, string, structs)
|
||||
- Comparison with standard library alternatives
|
||||
- Memory allocation tracking
|
||||
|
||||
```go
|
||||
// Example benchmark results for lo.Uniq vs manual implementation
|
||||
BenchmarkLoUniq-8 1000000 1200 ns/op 800 B/op 4 allocs/op
|
||||
BenchmarkManualUniq-8 5000000 240 ns/op 0 B/op 0 allocs/op (when in-place)
|
||||
```
|
||||
|
||||
### Production Optimization Tips
|
||||
1. **Use `lo/mutable`** for large datasets when memory is a concern
|
||||
2. **Leverage `lo/parallel`** for CPU-bound operations on large collections
|
||||
3. **Choose appropriate helpers** - some have specialized variants for specific use cases
|
||||
4. **Profile your code** - use Go's built-in profiling tools to identify bottlenecks
|
||||
5. **Consider streaming** - use iterators for very large datasets that don't fit in memory
|
||||
|
||||
## Ecosystem and Community
|
||||
|
||||
### Related Projects
|
||||
Lo is part of a growing ecosystem of Go libraries that enhance developer productivity:
|
||||
|
||||
- **[samber/do](https://github.com/samber/do)**: A dependency injection toolkit based on Go 1.18+ Generics
|
||||
- **[samber/mo](https://github.com/samber/mo)**: Monads based on Go 1.18+ Generics (Option, Result, Either...)
|
||||
- **[samber/lo-logrus](https://github.com/samber/lo-logrus)**: Lo helpers for logrus structured logging
|
||||
|
||||
### Community and Contributions
|
||||
- **Active development**: Regular updates and improvements from maintainers
|
||||
- **Community contributions**: Hundreds of contributors from around the world
|
||||
- **Corporate adoption**: Used by major companies including startups, fintech, and enterprise organizations
|
||||
- **Discussions**: Active GitHub discussions for feature requests and support
|
||||
|
||||
### Learning Resources
|
||||
- **Documentation**: Comprehensive docs with examples for every helper
|
||||
- **GoDoc**: https://pkg.go.dev/github.com/samber/lo
|
||||
- **GitHub Discussions**: Community support and discussions
|
||||
- **Examples**: Real-world usage examples in the repository
|
||||
|
||||
## Migration and Adoption
|
||||
|
||||
### From Standard Library
|
||||
Migrating from standard library `slices` and `maps` packages is straightforward:
|
||||
- Lo provides similar APIs with additional features
|
||||
- Many helpers drop-in replace standard library functions
|
||||
- Enhanced error handling and edge case coverage
|
||||
|
||||
### From Other Libraries
|
||||
If you're coming from other utility libraries:
|
||||
- Lo emphasizes Go idioms over direct ports from other languages
|
||||
- Type safety is prioritized over dynamic patterns
|
||||
- Performance is a key consideration in all implementations
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see LICENSE file for details
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Lo stands on the shoulders of giants:
|
||||
- Inspired by Lodash, Underscore.js, and functional programming concepts
|
||||
- Built upon Go's excellent generics implementation
|
||||
- Community-driven with contributions from hundreds of developers
|
||||
- Production-tested across diverse use cases and industries
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
// This file is not used in compilation. It is here just for a nice editor experience.
|
||||
"extends": "@docusaurus/tsconfig",
|
||||
"compilerOptions": {
|
||||
"baseUrl": "."
|
||||
},
|
||||
"exclude": [".docusaurus", "build"]
|
||||
}
|
||||
Reference in New Issue
Block a user