Skip to content

Commit cd4b1c9

Browse files
committed
Rename the lib
1 parent 3e13e9c commit cd4b1c9

4 files changed

Lines changed: 22 additions & 22 deletions

File tree

.github/workflows/package-validation.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ jobs:
4141
run: |
4242
cd test-project
4343
if [ "${{ matrix.package-manager }}" = "yarn" ]; then
44-
yarn add ../atlassian-xencoding-*.tgz
44+
yarn add ../lexicographic-keys-*.tgz
4545
else
46-
npm install ../atlassian-xencoding-*.tgz
46+
npm install ../lexicographic-keys-*.tgz
4747
fi
4848
4949
- name: Test package usage
5050
run: |
5151
cd test-project
5252
cat > test.mjs << 'EOF'
53-
import { encode, decode } from 'xencoding';
53+
import { encode, decode } from '@lexicographic/keys';
5454
5555
// Test basic functionality
5656
const encoded = encode('test', 123, 'data');

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Xencoding
1+
# Contributing to @lexicographic/keys
22

3-
Thank you for considering a contribution to Xencoding! Pull requests, issues and comments are welcome. For pull requests, please:
3+
Thank you for considering a contribution to `@lexicographic/keys`! Pull requests, issues and comments are welcome. For pull requests, please:
44

55
* Add tests for new features and bug fixes
66
* Follow the existing style
@@ -15,4 +15,4 @@ Atlassian requires contributors to sign a Contributor License Agreement, known a
1515
Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual.
1616

1717
* [CLA for corporate contributors](https://opensource.atlassian.com/corporate)
18-
* [CLA for individuals](https://opensource.atlassian.com/individual)
18+
* [CLA for individuals](https://opensource.atlassian.com/individual)

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Xencoding
1+
# @lexicographic/keys
22

3-
[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![npm version](https://img.shields.io/npm/v/xencoding.svg?style=flat-square)](https://www.npmjs.com/package/xencoding) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
3+
[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![npm version](https://img.shields.io/npm/v/@lexicographic/keys.svg?style=flat-square)](https://www.npmjs.com/package/@lexicographic/keys) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
44

5-
Xencoding is a lexicographical encoding library that converts mixed-type data (strings and numbers) into sortable string keys. This enables efficient range queries and prefix matching in key-value stores\databases (i.e DynamoDB), and other systems that rely on lexicographical ordering.
5+
`@lexicographic/keys` is a lexicographical encoding library that converts mixed-type data (strings and numbers) into sortable string keys. This enables efficient range queries and prefix matching in key-value stores\databases (i.e DynamoDB), and other systems that rely on lexicographical ordering.
66

77
## Key Features
88

@@ -12,9 +12,9 @@ Xencoding is a lexicographical encoding library that converts mixed-type data (s
1212
- **Type Safety**: Full TypeScript support with comprehensive type definitions
1313
- **Zero Dependencies**: Lightweight pure JavaScript implementation
1414

15-
## Why Xencoding?
15+
## Why `@lexicographic/keys`?
1616

17-
Xencoding offers several advantages over alternative encoding libraries like [charwise](https://github.com/dominictarr/charwise):
17+
`@lexicographic/keys` offers several advantages over alternative encoding libraries like [charwise](https://github.com/dominictarr/charwise):
1818

1919
- **Human-Readable Output**: Generated keys are a lot more readable
2020
- **Proper Integer Handling**: Treats integers as integers rather than converting them to floats, preserving precision and natural sorting
@@ -26,7 +26,7 @@ Xencoding offers several advantages over alternative encoding libraries like [ch
2626
### Basic Encoding and Decoding
2727

2828
```typescript
29-
import { encode, decode } from 'xencoding';
29+
import { encode, decode } from '@lexicographic/keys';
3030

3131
// Encode mixed types into a sortable string
3232
const key = encode('user', 42, 'profile');
@@ -40,7 +40,7 @@ console.log(values); // ['user', 42, 'profile']
4040
### Lexicographical Ordering
4141

4242
```typescript
43-
import { encode } from 'xencoding';
43+
import { encode } from '@lexicographic/keys';
4444

4545
// Create keys that sort correctly
4646
const keys = [
@@ -64,7 +64,7 @@ console.log(sorted);
6464
### Prefix Matching
6565

6666
```typescript
67-
import { encode } from 'xencoding';
67+
import { encode } from '@lexicographic/keys';
6868

6969
// Create a prefix for queries
7070
const prefix = encode('app', 'deployment');
@@ -89,7 +89,7 @@ console.log(matchingKeys);
8989
### Working with Negative Numbers
9090

9191
```typescript
92-
import { encode, decode } from 'xencoding';
92+
import { encode, decode } from '@lexicographic/keys';
9393

9494
// Negative numbers are supported and sort correctly
9595
const keys = [
@@ -107,13 +107,13 @@ console.log(keys.sort());
107107
## Installation
108108

109109
```bash
110-
yarn add xencoding
110+
yarn add @lexicographic/keys
111111
```
112112

113113
Or with npm:
114114

115115
```bash
116-
npm install xencoding
116+
npm install @lexicographic/keys
117117
```
118118

119119
## API Documentation
@@ -182,7 +182,7 @@ The library includes comprehensive tests covering:
182182

183183
## Contributions
184184

185-
Contributions to Xencoding are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
185+
Contributions to `@lexicographic/keys` are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
186186

187187
## License
188188

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "xencoding",
2+
"name": "@lexicographic/keys",
33
"version": "0.9.0",
44
"main": "dist/index.js",
55
"types": "dist/index.d.ts",
@@ -32,9 +32,9 @@
3232
],
3333
"repository": {
3434
"type": "git",
35-
"url": "git+ssh://git@github.com/atlassian-labs/xencoding.git"
35+
"url": "git+ssh://git@github.com/atlassian-labs/lexicographic-keys.git"
3636
},
37-
"homepage": "https://github.com/atlassian-labs/xencoding/",
37+
"homepage": "https://github.com/atlassian-labs/lexicographic-keys/",
3838
"files": [
3939
"dist/",
4040
"!dist/__test__/**"
@@ -62,4 +62,4 @@
6262
"typescript": "^5.9.2",
6363
"typescript-eslint": "^8.39.0"
6464
}
65-
}
65+
}

0 commit comments

Comments
 (0)