Skip to content

Commit

Permalink
chore: update configs
Browse files Browse the repository at this point in the history
  • Loading branch information
tmm committed May 23, 2023
1 parent 2b5a0a8 commit 945c42c
Show file tree
Hide file tree
Showing 10 changed files with 207 additions and 133 deletions.
10 changes: 2 additions & 8 deletions .github/CONTRIBUTING.md
Expand Up @@ -4,9 +4,7 @@ Thanks for your interest in contributing to ABIType! Please take a moment to rev

If you want to contribute, but aren't sure where to start, you can create a [new discussion](https://github.com/wagmi-dev/abitype/discussions).

> **Note**
>
> **Please ask first before starting work on any significant new features.**
> **Note** **Please ask first before starting work on any significant new features.**
>
> It's never a fun experience to have your pull request declined after investing time and effort into a new feature. To avoid this from happening, we request that contributors create a [feature request](https://github.com/wagmi-dev/abitype/discussions/new?category=ideas) to first discuss any API changes or significant new ideas.
Expand Down Expand Up @@ -142,16 +140,12 @@ When you submit a pull request, GitHub will automatically lint, build, and test

When adding new features or fixing bugs, we'll need to bump the package versions. We use [Changesets](https://github.com/changesets/changesets) to do this.

> **Note**
>
> Only changes to the codebase that affect the public API or existing behavior (e.g. bugs) need changesets.
> **Note** Only changes to the codebase that affect the public API or existing behavior (e.g. bugs) need changesets.
Each changeset defines which package(s) should be published and whether the change should be a major/minor/patch release, as well as providing release notes that will be added to the changelog upon release.

To create a new changeset, run `pnpm changeset`. This will run the Changesets CLI, prompting you for details about the change. You’ll be able to edit the file after it’s created — don’t worry about getting everything perfect up front.

Since we’re currently in beta, all changes should be marked as a minor/patch release to keep us within the `v0.x` range.

Even though you can technically use any markdown formatting you like, headings should be avoided since each changeset will ultimately be nested within a bullet list. Instead, bold text should be used as section headings.

If your PR is making changes to an area that already has a changeset (e.g. there’s an existing changeset covering theme API changes but you’re making further changes to the same API), you should update the existing changeset in your PR rather than creating a new one.
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Expand Up @@ -58,9 +58,9 @@ body:
label: Validations
description: Before submitting this issue, please make sure you do the following.
options:
- label: Checked there isn't [already an issue](https://github.com/wagmi-dev/abitype/issues) that exists for the bug you encountered.
required: true
- label: Followed the [Code of Conduct](https://github.com/wagmi-dev/.github/blob/main/CODE_OF_CONDUCT.md).
required: true
- label: Read the [Contributing Guide](https://github.com/wagmi-dev/abitype/blob/main/.github/CONTRIBUTING.md).
required: true
- label: Checked there isn't [already an issue](https://github.com/wagmi-dev/abitype/issues) that exists for the bug you encountered.
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Ask Question
- name: Question
url: https://github.com/wagmi-dev/abitype/discussions/new?category=q-a
about: Ask questions and discuss with other community members.
- name: Request Feature
- name: Feature Request
url: https://github.com/wagmi-dev/abitype/discussions/new?category=ideas
about: Requests features or brainstorm ideas for new functionality.
17 changes: 0 additions & 17 deletions .github/stale.yml

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022-PRESENT weth, LLC
Copyright (c) 2022-present weth, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions examples/signTypedData.ts
Expand Up @@ -13,21 +13,21 @@ type SignTypedDataConfig<
TTypedData extends TypedData | { [key: string]: unknown } = TypedData,
_Schema = TTypedData extends TypedData
? TypedDataToPrimitiveTypes<TTypedData>
: { [key: string]: any },
: { [_: string]: any },
_Value = _Schema[keyof _Schema],
> = {
/** Domain info */
domain: TypedDataDomain
/** Named list of all type definitions */
types: TTypedData
} & ({ [key: string]: any } extends _Value // Check if we were able to infer the shape of typed data
} & ({ [__: string]: any } extends _Value // Check if we were able to infer the shape of typed data
? {
/**
* Data to sign
*
* Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link types} for type inference.
*/
value: { [key: string]: unknown }
value: { [___: string]: unknown }
}
: {
/** Data to sign */
Expand Down
28 changes: 14 additions & 14 deletions package.json
Expand Up @@ -2,6 +2,8 @@
"name": "abitype",
"description": "Strict TypeScript types for Ethereum ABIs",
"version": "0.8.4",
"license": "MIT",
"repository": "wagmi-dev/abitype",
"scripts": {
"bench": "vitest bench",
"build": "pnpm run clean && pnpm run build:cjs && pnpm run build:esm && pnpm run build:types",
Expand All @@ -28,12 +30,6 @@
"trace": "tsc --noEmit --generateTrace ./trace --incremental false --project playground/tsconfig.json",
"typecheck": "tsc --noEmit"
},
"type": "module",
"main": "./dist/cjs/index.js",
"module": "./dist/esm/index.js",
"types": "./dist/types/index.d.ts",
"typings": "./dist/types/index.d.ts",
"sideEffects": false,
"files": [
"dist",
"!dist/**/*.tsbuildinfo",
Expand All @@ -43,6 +39,12 @@
"!src/**/*.bench.ts",
"!src/_test/**/*"
],
"sideEffects": false,
"type": "module",
"main": "./dist/cjs/index.js",
"module": "./dist/esm/index.js",
"types": "./dist/types/index.d.ts",
"typings": "./dist/types/index.d.ts",
"exports": {
".": {
"types": "./dist/types/index.d.ts",
Expand Down Expand Up @@ -96,20 +98,18 @@
"@types/node": "18.16.3",
"@vitest/coverage-c8": "^0.30.1",
"bun": "^0.5.7",
"ethers": "^6.0.5",
"ethers": "^6.4.0",
"fs-extra": "^11.1.0",
"rimraf": "^5.0.0",
"rome": "^12.0.0",
"rimraf": "^5.0.1",
"rome": "^12.1.2",
"simple-git-hooks": "^2.8.1",
"typescript": "^5.0.4",
"vitest": "^0.30.1",
"zod": "^3.20.6"
},
"license": "MIT",
"repository": "wagmi-dev/abitype",
"authors": [
"awkweb.eth",
"jxom.eth"
"contributors": [
"jxom.eth <j@wagmi.sh>",
"awkweb.eth <t@wagmi.sh>"
],
"funding": [
{
Expand Down

1 comment on commit 945c42c

@vercel
Copy link

@vercel vercel bot commented on 945c42c May 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

abitype – ./

abitype.vercel.app
abitype-wagmi-dev.vercel.app
abitype-git-main-wagmi-dev.vercel.app
abitype.dev

Please sign in to comment.