Skip to content

Commit

Permalink
chore: use new documentation domain (#206)
Browse files Browse the repository at this point in the history
  • Loading branch information
MarlonPassos-git authored Aug 20, 2024
1 parent eb69b4b commit 42bcb6a
Show file tree
Hide file tree
Showing 131 changed files with 165 additions and 165 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ _“What makes Radashi so great?”_
- **nightly releases** (`radashi@beta`)
- **changelog** (easily see what's new in each release)

_If you've been using Radash (our predecessor), you're probably interested in what makes us different. Read [our comparison post](https://radashi-org.github.io/blog/vs-radash) to learn how we're bringing Radash to the next level while preserving its best features._
_If you've been using Radash (our predecessor), you're probably interested in what makes us different. Read [our comparison post](https://radashi.js.org/blog/vs-radash) to learn how we're bringing Radash to the next level while preserving its best features._

<a href="https://radashi-org.github.io">
<a href="https://radashi.js.org">
<img src="https://github.com/radashi-org/radashi/raw/main/.github/img/docs-button.png" alt="Radash documentation" width="250px" />
</a>

Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"repository": {
"url": "git+https://github.com/radashi-org/radashi.git"
},
"homepage": "https://radashi-org.github.io",
"homepage": "https://radashi.js.org",
"author": "Alec Larson",
"contributors": [
"Ray Epps"
Expand Down Expand Up @@ -46,6 +46,9 @@
"test-single": "bash ./scripts/test-single.sh",
"update-browserslist": "bash ./scripts/update-browserslist.sh"
},
"dependencies": {
"@radashi-org/biome-config": "link:scripts/biome-config"
},
"devDependencies": {
"@biomejs/biome": "^1.8.3",
"@vitest/coverage-v8": "2.0.5",
Expand Down Expand Up @@ -80,8 +83,5 @@
"unreleased opera versions",
"unreleased firefox versions",
"node >= 16"
],
"dependencies": {
"@radashi-org/biome-config": "link:scripts/biome-config"
}
]
}
2 changes: 1 addition & 1 deletion scripts/add-function.sh
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ fi

if [ ! -f "$SRC_FILE" ]; then
mkdir -p "$SRC_DIR"
echo -e "/**\n * Does a thing.\n *\n * @see https://radashi-org.github.io/reference/$GROUP_NAME/$FUNC_NAME\n * @example\n * \`\`\`ts\n * $FUNC_NAME()\n * \`\`\`\n */\nexport function $FUNC_NAME(): void {}\n" > "$SRC_FILE"
echo -e "/**\n * Does a thing.\n *\n * @see https://radashi.js.org/reference/$GROUP_NAME/$FUNC_NAME\n * @example\n * \`\`\`ts\n * $FUNC_NAME()\n * \`\`\`\n */\nexport function $FUNC_NAME(): void {}\n" > "$SRC_FILE"
else
echo "Warning: $SRC_FILE already exists. Skipping."
fi
Expand Down
6 changes: 3 additions & 3 deletions scripts/benchmarks/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"type": "module",
"private": true,
"scripts": {
"test": "vitest"
},
"dependencies": {
"@babel/parser": "^7.25.3",
"@babel/traverse": "^7.25.3",
Expand All @@ -16,8 +19,5 @@
"ts-morph": "^23.0.0",
"tsx": "^4.17.0",
"vitest": "link:../../node_modules/vitest"
},
"scripts": {
"test": "vitest"
}
}
2 changes: 1 addition & 1 deletion scripts/benchmarks/src/dedent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { isArray } from 'radashi/typed/isArray.js'
* most use cases, so you should only set an explicit `indent` if
* necessary.
*
* @see https://radashi-org.github.io/reference/string/dedent
* @see https://radashi.js.org/reference/string/dedent
* @example
* ```ts
* // This is indented with 4 spaces.
Expand Down
26 changes: 13 additions & 13 deletions scripts/biome-config/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,34 @@
"name": "@radashi-org/biome-config",
"version": "1.0.0",
"description": "Shared Biome config for Radashi projects",
"keywords": [
"radashi",
"biome",
"biomejs",
"config",
"configuration",
"formatter",
"linter"
],
"repository": {
"url": "git+https://github.com/radashi-org/radashi.git"
},
"homepage": "https://radashi-org.github.io",
"license": "MIT",
"homepage": "https://radashi.js.org",
"author": {
"name": "Alec Larson"
},
"license": "MIT",
"main": "biome.json",
"exports": {
".": "./biome.json"
},
"main": "biome.json",
"files": [
"biome.json"
],
"keywords": [
"radashi",
"biome",
"biomejs",
"config",
"configuration",
"formatter",
"linter"
],
"peerDependencies": {
"@biomejs/biome": "^1.8.3"
},
"trustedDependencies": [
"@biomejs/biome"
]
}
}
2 changes: 1 addition & 1 deletion scripts/bundle-impact/src/dedent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { isArray } from 'radashi/typed/isArray.js'
* most use cases, so you should only set an explicit `indent` if
* necessary.
*
* @see https://radashi-org.github.io/reference/string/dedent
* @see https://radashi.js.org/reference/string/dedent
* @example
* ```ts
* // This is indented with 4 spaces.
Expand Down
4 changes: 2 additions & 2 deletions scripts/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"private": true,
"type": "module",
"private": true,
"dependencies": {
"@types/node": "^22.3.0",
"execa": "^9.3.1",
Expand All @@ -11,4 +11,4 @@
"radashi-db": "link:../radashi-db",
"tsx": "^4.17.0"
}
}
}
6 changes: 3 additions & 3 deletions scripts/functions/src/util/bottleneck.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ declare const setTimeout: (callback: () => void, delay: number) => unknown
/**
* The options for the `bottleneck` function.
*
* @see https://radashi-org.github.io/reference/async/bottleneck
* @see https://radashi.js.org/reference/async/bottleneck
*/
export interface BottleneckOptions {
/**
Expand All @@ -27,7 +27,7 @@ export interface BottleneckOptions {
/**
* The return type of the `bottleneck` function.
*
* @see https://radashi-org.github.io/reference/async/bottleneck
* @see https://radashi.js.org/reference/async/bottleneck
*/
export type BottledFunction<Fn extends (...args: any[]) => any> = Fn & {
/**
Expand Down Expand Up @@ -56,7 +56,7 @@ export type BottledFunction<Fn extends (...args: any[]) => any> = Fn & {
* Use the `concurrency` option for limiting the number of concurrent
* calls.
*
* @see https://radashi-org.github.io/reference/async/bottleneck
* @see https://radashi.js.org/reference/async/bottleneck
* @example
* ```ts
* const double = bottleneck(
Expand Down
2 changes: 1 addition & 1 deletion scripts/release-notes/dedent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { isArray } from 'radashi/typed/isArray.js'
* most use cases, so you should only set an explicit `indent` if
* necessary.
*
* @see https://radashi-org.github.io/reference/string/dedent
* @see https://radashi.js.org/reference/string/dedent
* @example
* ```ts
* // This is indented with 4 spaces.
Expand Down
2 changes: 1 addition & 1 deletion scripts/versions/src/dedent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { isArray } from 'radashi/typed/isArray.js'
* most use cases, so you should only set an explicit `indent` if
* necessary.
*
* @see https://radashi-org.github.io/reference/string/dedent
* @see https://radashi.js.org/reference/string/dedent
* @example
* ```ts
* // This is indented with 4 spaces.
Expand Down
2 changes: 1 addition & 1 deletion src/array/alphabetical.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Sort an array without modifying it and return the newly sorted
* value. Allows for a string sorting value.
*
* @see https://radashi-org.github.io/reference/array/alphabetical
* @see https://radashi.js.org/reference/array/alphabetical
*/
export function alphabetical<T>(
array: readonly T[],
Expand Down
2 changes: 1 addition & 1 deletion src/array/boil.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* comparing with the second. Keep the one you want then compare that
* to the next item in the list with the same.
*
* @see https://radashi-org.github.io/reference/array/boil
* @see https://radashi.js.org/reference/array/boil
* @example
* ```ts
* boil([1, 2, 3, 0], (a, b) => a > b ? a : b) // 3
Expand Down
4 changes: 2 additions & 2 deletions src/array/castArray.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* array, a shallow copy is returned. Otherwise, a new array
* containing the value is returned.
*
* @see https://radashi-org.github.io/reference/array/castArray
* @see https://radashi.js.org/reference/array/castArray
* @example
* ```ts
* castArray(1) // => [1]
Expand All @@ -20,7 +20,7 @@ export function castArray(value: unknown): unknown {
/**
* The return type of the {@link castArray} function.
*
* @see https://radashi-org.github.io/reference/array/castArray
* @see https://radashi.js.org/reference/array/castArray
*/
export type CastArray<T> = [T] extends [never]
? never[]
Expand Down
4 changes: 2 additions & 2 deletions src/array/castArrayIfExists.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* `undefined`. If the value is an array, it returns a shallow copy of
* the array. Otherwise, it returns a new array containing the value.
*
* @see https://radashi-org.github.io/reference/array/castArrayIfExists
* @see https://radashi.js.org/reference/array/castArrayIfExists
* @example
* ```ts
* castArrayIfExists(1) // => [1]
Expand All @@ -20,7 +20,7 @@ export function castArrayIfExists(value: unknown): unknown {
/**
* The return type of the {@link castArrayIfExists} function.
*
* @see https://radashi-org.github.io/reference/array/castArrayIfExists
* @see https://radashi.js.org/reference/array/castArrayIfExists
*/
export type CastArrayIfExists<T> = [T] extends [never]
? never[]
Expand Down
2 changes: 1 addition & 1 deletion src/array/cluster.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Splits a single list into many lists of the desired size.
*
* @see https://radashi-org.github.io/reference/array/cluster
* @see https://radashi.js.org/reference/array/cluster
* @example
* ```ts
* cluster([1, 2, 3, 4, 5, 6], 2)
Expand Down
2 changes: 1 addition & 1 deletion src/array/counting.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Counts the occurrences of each unique value returned by the `identity`
* function when applied to each item in the array.
*
* @see https://radashi-org.github.io/reference/array/counting
* @see https://radashi.js.org/reference/array/counting
* @example
* ```ts
* counting([1, 2, 3, 4], (n) => n % 2 === 0 ? 'even' : 'odd')
Expand Down
2 changes: 1 addition & 1 deletion src/array/diff.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Returns all items from the first list that do not exist in the
* second list.
*
* @see https://radashi-org.github.io/reference/array/diff
* @see https://radashi.js.org/reference/array/diff
* @example
* ```ts
* diff([1, 2, 3, 4], [2, 4])
Expand Down
2 changes: 1 addition & 1 deletion src/array/first.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Get the first item in an array or a default value.
*
* @see https://radashi-org.github.io/reference/array/first
* @see https://radashi.js.org/reference/array/first
* @example
* ```ts
* first([1, 2, 3, 4])
Expand Down
2 changes: 1 addition & 1 deletion src/array/flat.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Given an array of arrays, returns a single dimensional array with
* all items in it.
*
* @see https://radashi-org.github.io/reference/array/flat
* @see https://radashi.js.org/reference/array/flat
* @example
* ```ts
* flat([[1, 2], [[3], 4], [5]])
Expand Down
2 changes: 1 addition & 1 deletion src/array/fork.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Split an array into two array based on a true/false condition
* function.
*
* @see https://radashi-org.github.io/reference/array/fork
* @see https://radashi.js.org/reference/array/fork
* @example
* ```ts
* fork([1, 2, 3, 4], (n) => n % 2 === 0)
Expand Down
2 changes: 1 addition & 1 deletion src/array/group.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* where the keys are the group IDs the given `getGroupId` function
* produced and the value is an array of each item in that group.
*
* @see https://radashi-org.github.io/reference/array/group
* @see https://radashi.js.org/reference/array/group
* @example
* ```ts
* group([1, 2, 3, 4], (n) => n % 2 === 0 ? 'even' : 'odd')
Expand Down
2 changes: 1 addition & 1 deletion src/array/intersects.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Given two arrays, returns true if any elements intersect.
*
* @see https://radashi-org.github.io/reference/array/intersects
* @see https://radashi.js.org/reference/array/intersects
* @example
* ```ts
* intersects([1, 2, 3], [4, 5, 6])
Expand Down
2 changes: 1 addition & 1 deletion src/array/iterate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* NOTE: This is NOT zero indexed. If you pass count=5 you will get 1,
* 2, 3, 4, 5 iteration in the callback function.
*
* @see https://radashi-org.github.io/reference/array/iterate
* @see https://radashi.js.org/reference/array/iterate
* @example
* ```ts
* iterate(3, (total, i) => total + i, 0)
Expand Down
2 changes: 1 addition & 1 deletion src/array/last.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Get the last item in an array or a default value.
*
* @see https://radashi-org.github.io/reference/array/last
* @see https://radashi.js.org/reference/array/last
* @example
* ```ts
* last([1, 2, 3, 4])
Expand Down
2 changes: 1 addition & 1 deletion src/array/list.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { range } from 'radashi'
/**
* Creates a list of given start, end, value, and step parameters.
*
* @see https://radashi-org.github.io/reference/array/list
* @see https://radashi.js.org/reference/array/list
* @example
* ```ts
* list(3) // 0, 1, 2, 3
Expand Down
2 changes: 1 addition & 1 deletion src/array/mapify.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Create a new `Map` instance from an array.
*
* @see https://radashi-org.github.io/reference/array/mapify
* @see https://radashi.js.org/reference/array/mapify
* @example
* ```ts
* const array = [
Expand Down
2 changes: 1 addition & 1 deletion src/array/merge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* replace items matched by the `matcher` function in the first place.
* The given arrays are never modified.
*
* @see https://radashi-org.github.io/reference/array/merge
* @see https://radashi.js.org/reference/array/merge
* @example
* ```ts
* merge(
Expand Down
2 changes: 1 addition & 1 deletion src/array/objectify.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Convert an array to a dictionary by mapping each item into a
* dictionary key & value.
*
* @see https://radashi-org.github.io/reference/array/objectify
* @see https://radashi.js.org/reference/array/objectify
* @example
* ```ts
* objectify([1, 2, 3], (n) => '#' + n)
Expand Down
2 changes: 1 addition & 1 deletion src/array/replace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Replace an element in an array with a new item without modifying
* the array and return the new value.
*
* @see https://radashi-org.github.io/reference/array/replace
* @see https://radashi.js.org/reference/array/replace
* @example
* ```ts
* replace([1, 2, 3], 4, (n) => n === 2)
Expand Down
2 changes: 1 addition & 1 deletion src/array/replaceOrAppend.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* `match` function returns true. If no items match, append the new
* item to the end of the list.
*
* @see https://radashi-org.github.io/reference/array/replaceOrAppend
* @see https://radashi.js.org/reference/array/replaceOrAppend
* @example
* ```ts
* replaceOrAppend([1, 2, 3], 4, (n) => n > 1)
Expand Down
Loading

0 comments on commit 42bcb6a

Please sign in to comment.