New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

feat: added string-store #118

Draft

kyranet wants to merge 5 commits into main from feat/added-string-store

Member

kyranet commented May 24, 2021 •

edited

TODO

Dynamically increase size on size-unknown payloads.
Add tests, lots of tests
- Does this thing even work? Endianness is a pain.

kyranet added the Meta: Feature label

kyranet requested review from favna and vladfrangu

May 24, 2021 16:34

vladfrangu requested changes

View reviewed changes

.github/CODEOWNERS Outdated Show resolved Hide resolved

favna force-pushed the main branch from 99233b4 to 600390f Compare

July 20, 2021 21:53

Nytelife26 reviewed

View reviewed changes

packages/string-store/package.json Outdated Show resolved Hide resolved

packages/string-store/src/lib/data/UnalignedBufferReader.ts Outdated

Comment on lines 4 to 6

+              	public readBit(): Bit {
+              		return this.read(1n) as Bit;
+              	}

Contributor

Nytelife26 Aug 5, 2021

Consider using a helper generator instead of re-implementing the same function innumerable times.
This could be done as follows, for instance:

function readBitX<T>(this: UnalignedBuffer, x: Size) {
    return () => {
        return this.read(x) as T;
    }
}

And then applying the generated functions to the class. This is as close to a macro as TypeScript will allow, but more readable and convenient.

packages/string-store/src/lib/data/UnalignedBufferWriter.ts Outdated

Comment on lines 14 to 19

+              	public writeBit(bit: Bit): void {
+              		this.memoryData <<= 1n;
+              		this.memoryData |= bit & 0b0001n;
+              		this.memoryBits += 1n;
+              		this.ensureCurrentByte();
+              	}

Contributor

Nytelife26 Aug 5, 2021

Same as with readBit.

packages/string-store/src/lib/types/Array.ts

		@@ -0,0 +1,40 @@
		import type { IType } from './IType';

		export function Array<SType, DType>(type: IType<SType, DType>, length: number \| null = null) {

Contributor

Nytelife26 Aug 5, 2021

Suggested change

      
            export function Array<SType, DType>(type: IType<SType, DType>, length: number | null = null) {
          
            export function Array<SType, DType>(type: IType<SType, DType>, length: number | null = null) {

It is largely unclear what SType and DType relate to here. Given that Type is implied by their usage, ignoring them, it's roughly as vague as S and D, which appear to have no real standardized use. Consider swapping those out.

Member

favna Jul 27, 2022

Bump, kyra

Nytelife26 mentioned this pull request

feat(discord.js-utilities): add many more utilities #147

Merged

favna requested changes

View reviewed changes

.github/workflows/cd-string-store.yml Outdated Show resolved Hide resolved

packages/string-store/CHANGELOG.md Outdated Show resolved Hide resolved

packages/string-store/README.md Outdated Show resolved Hide resolved

packages/string-store/package.json Outdated Show resolved Hide resolved

favna force-pushed the main branch 2 times, most recently from 1b1ed93 to a3e5cf0 Compare

August 11, 2021 23:30

Collaborator

Lioness100 commented Oct 19, 2021 •

edited

Fancy jargon too fancy for me D:
What exactly is the use case of this?

Edit: answered in discord

Fyko reviewed

View reviewed changes

packages/string-store/README.md Outdated Show resolved Hide resolved

favna force-pushed the feat/added-string-store branch 2 times, most recently from db89866 to 1680a5b Compare

January 20, 2022 21:26

favna reviewed

View reviewed changes

packages/string-store/src/lib/StringStoreEntry.ts Show resolved Hide resolved

packages/string-store/src/lib/StringStoreEntry.ts Outdated Show resolved Hide resolved

favna assigned kyranet

github-actions bot removed the Meta: Feature label

favna added this to the Future milestone

favna added the packages:string-store label

kyranet added 2 commits

July 24, 2022 22:51


          feat: added string-store

da202bd


          chore: update package

10daf42

kyranet force-pushed the feat/added-string-store branch from 4faef40 to 10daf42 Compare

July 24, 2022 21:01

kyranet added 3 commits

July 25, 2022 00:58


          chore: progress

d958572


          chore: fixed requested changes

7b45c6e


          fix: resolved test errors

ed9f6c8

favna requested changes

View reviewed changes

packages/string-store/README.md


		![Sapphire Logo](https://cdn.skyra.pw/gh-assets/sapphire-banner.png)

		# @sapphire/stopwatch

Member

favna Jul 26, 2022

I'll stop your watch

packages/string-store/README.md

+              [![GitHub](https://img.shields.io/github/license/sapphiredev/utilities)](https://github.com/sapphiredev/utilities/blob/main/LICENSE.md)
+              [![codecov](https://codecov.io/gh/sapphiredev/utilities/branch/main/graph/badge.svg?token=OEGIV6RFDO)](https://codecov.io/gh/sapphiredev/utilities)
+              [![npm bundle size](https://img.shields.io/bundlephobia/min/@sapphire/stopwatch?logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=@sapphire/stopwatch)

Member

favna Jul 26, 2022

I'll stop your clock

packages/string-store/README.md

+              [![GitHub](https://img.shields.io/github/license/sapphiredev/utilities)](https://github.com/sapphiredev/utilities/blob/main/LICENSE.md)
+              [![codecov](https://codecov.io/gh/sapphiredev/utilities/branch/main/graph/badge.svg?token=OEGIV6RFDO)](https://codecov.io/gh/sapphiredev/utilities)
+              [![npm bundle size](https://img.shields.io/bundlephobia/min/@sapphire/stopwatch?logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=@sapphire/stopwatch)
+              [![npm](https://img.shields.io/npm/v/@sapphire/stopwatch?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/stopwatch)

Member

favna Jul 26, 2022

I'll stop your chronometer

packages/string-store/README.md

+              You can use the following command to install this package, or replace `npm install` with your package manager of choice.
+              ```sh
+              npm install @sapphire/stopwatch

Member

favna Jul 26, 2022

I'll stop your ticker

packages/string-store/package.json

@@ @@ -0,0 +1,64 @@ @@
+              {
+              	"name": "@sapphire/string-store",
+              	"version": "0.0.1",

Member

favna Jul 26, 2022

Suggested change

      
            	"version": "0.0.1",
          
            	"version": "1.0.0",

packages/string-store/package.json

Comment on lines +25 to +27

+              	"dependencies": {
+              		"tslib": "^2.4.0"
+              	},

Member

favna Jul 26, 2022

Suggested change

      
            	"dependencies": {
          
            		"tslib": "^2.4.0"
          
            	},

Should not be needed when compiling with tsup but I suppose check the dist output

packages/string-store/src/index.ts

+              export * from './lib/data/writer/AlignedWriter';
+              export * from './lib/data/writer/IWriter';
+              export * from './lib/StringStore';
+              export * as Types from './lib/Types';

Member

favna Jul 26, 2022

Suggested change

      
            export * as Types from './lib/Types';
          
            export * from './lib/Types';

Any particular reason why you made it namespaced under Types?

packages/string-store/src/lib/data/writer/AlignedWriter.ts

+              	}
+              	public finish(): void {
+              		// NOP: Aligned writer does not use a double buffer.

Member

favna Jul 27, 2022

Suggested change

      
            		// NOP: Aligned writer does not use a double buffer.
          
            		// NO-OP: Aligned writer does not use a double buffer.

Not I know but it's "no operation" so it needs 2 O's. No one uses "NOP".

packages/string-store/src/lib/types/Array.ts

		@@ -0,0 +1,40 @@
		import type { IType } from './IType';

		export function Array<SType, DType>(type: IType<SType, DType>, length: number \| null = null) {

Member

favna Jul 27, 2022

Bump, kyra

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment