@code4rena/skeleton

a code-skeleton config for code4rena usage

> npm i -D --save-exact @code4rena/skeleton
> npm pkg set skeleton.module=@code4rena/skeleton
> npx code-skeleton apply

Configuration & Usage

Important Note on '@tsconfig/node18/tsconfig.json' not found, and Tap:

There is currently an issue in ts-node that causes a loading problem when combined with Tap.js. There is a recommended workaround for this. Once you update your skeleton, swap out these plugins:

npx tap plugin add @tapjs/tsx
npx tap plugin rm @tapjs/typescript

CI

In your projects package.json you can set custom CI variables to extend the default workflow. The following configuration will add a Postgres service to the test job, as well as inject the DOTENV_KEY environment variables for dotenv vault usage.

  "skeleton": {
    "variables": {
      "ci": {
        "postgres": true,
        "env_vault": true
      }
    }
  },

Postgres Container

When enabled, you will need to set the following repository variables in your github repos action variables ({repo}/settings/variables/actions):

• POSTGRES_DB
• POSTGRES_PASSWORD
• POSTGRES_PORT
• POSTGRES_USER

Dotenv Vault

When enabled, in addition to a commited .env.vault file, you will need to set the DOTENV_KEY environment secret for the desired .env file from your .env.keys file. Set this as a repository secret at {repo}/settings/secrets/actions on github.

Update your skeleton version

Check the latest version Run: npm i -D --save-exact @code4rena/skeleton@[LATEST_VERSION] Then: npx code-skeleton apply

Potential issue with shebang

If you see a Permission Denied issue with shebang, you can run chmod +x ./scripts/update-shebang.ts