Skip to content

Commit

Permalink
feat: lint step
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaelcr committed Jun 27, 2024
1 parent 3726ab8 commit 32377d9
Show file tree
Hide file tree
Showing 8 changed files with 251 additions and 7 deletions.
1 change: 1 addition & 0 deletions api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Runes API
200 changes: 200 additions & 0 deletions api/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
/*
* For a detailed explanation regarding each configuration property, visit:
* https://jestjs.io/docs/configuration
*/

module.exports = {
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "/private/var/folders/v3/swygw5ld38x59y9wtc2qv3fc0000gn/T/jest_dx",

// Automatically clear mock calls, instances, contexts and results before every test
// clearMocks: false,

// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,

// An array of glob patterns indicating a set of files for which coverage information should be collected
collectCoverageFrom: [
"src/**/*.ts",
],

// The directory where Jest should output its coverage files
// coverageDirectory: undefined,

// An array of regexp pattern strings used to skip coverage collection
coveragePathIgnorePatterns: [
"/node_modules/",
"/src/@types/"
],

// Indicates which provider should be used to instrument code for coverage
coverageProvider: "v8",

// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,

// A path to a custom dependency extractor
// dependencyExtractor: undefined,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// The default configuration for fake timers
// fakeTimers: {
// "enableGlobally": false
// },

// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
globalSetup: './tests/setup.ts',

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,

// A set of global variables that need to be available in all test environments
// globals: {},

// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",

// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],

// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "mjs",
// "cjs",
// "jsx",
// "ts",
// "tsx",
// "json",
// "node"
// ],

// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
// moduleNameMapper: {},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
preset: 'ts-jest',

// Run tests from one or more projects
// projects: undefined,

// Use this configuration option to add custom reporters to Jest
// reporters: undefined,

// Automatically reset mock state before every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: undefined,

// Automatically restore mock state and implementation before every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within
rootDir: '',

// A list of paths to directories that Jest should use to search for files in
// roots: [
// "<rootDir>"
// ],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],

// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing
// testEnvironment: "jest-environment-node",

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
// testMatch: [
// "**/__tests__/**/*.[jt]s?(x)",
// "**/?(*.)+(spec|test).[tj]s?(x)"
// ],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
testPathIgnorePatterns: [
"/node_modules/",
"/client/",
"/dist/"
],

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
// testResultsProcessor: undefined,

// This option allows use of a custom test runner
// testRunner: "jest-circus/runner",

// A map from regular expressions to paths to transformers
transform: {},

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "/node_modules/",
// "\\.pnp\\.[^\\/]+$"
// ],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: undefined,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
};
7 changes: 5 additions & 2 deletions api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@
"build": "rimraf ./dist && tsc --project tsconfig.build.json",
"start": "node dist/src/index.js",
"start-ts": "ts-node ./src/index.ts",
"generate:git-info": "rimraf .git-info && node_modules/.bin/api-toolkit-git-info"
"test": "jest --runInBand",
"generate:git-info": "rimraf .git-info && node_modules/.bin/api-toolkit-git-info",
"lint:eslint": "eslint . --ext .ts,.tsx -f unix",
"lint:prettier": "prettier --check src/**/*.ts tests/**/*.ts",
"lint:unused-exports": "ts-unused-exports tsconfig.json --showLineNumber --excludePathsFromReport=util/*"
},
"keywords": [],
"author": "Hiro Systems PBC <[email protected]> (https://hiro.so)",
"license": "Apache 2.0",
"prettier": "@stacks/prettier-config",
Expand Down
7 changes: 3 additions & 4 deletions api/src/api/schemas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,10 @@ export const LimitParamSchema = Type.Integer({
});
export type LimitParam = Static<typeof LimitParamSchema>;

export const RuneIdSchema = Type.RegEx(/^[0-9]+:[0-9]+$/);
export const RuneIdSchemaCType = TypeCompiler.Compile(RuneIdSchema);
export const RuneNameSchema = Type.RegEx(/^[A-Z]+$/);
const RuneIdSchema = Type.RegEx(/^[0-9]+:[0-9]+$/);
const RuneNameSchema = Type.RegEx(/^[A-Z]+$/);
export const RuneNameSchemaCType = TypeCompiler.Compile(RuneNameSchema);
export const RuneSpacedNameSchema = Type.RegEx(/^[A-Z]([A-Z]+)+$/);
const RuneSpacedNameSchema = Type.RegEx(/^[A-Z]([A-Z]+)+$/);
export const RuneSpacedNameSchemaCType = TypeCompiler.Compile(RuneSpacedNameSchema);

export const EtchingParamSchema = Type.Union([RuneIdSchema, RuneNameSchema, RuneSpacedNameSchema]);
Expand Down
2 changes: 1 addition & 1 deletion api/src/pg/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export type DbRune = {
timestamp: number;
};

export type DbLedgerOperation = 'mint' | 'burn' | 'send' | 'receive';
type DbLedgerOperation = 'mint' | 'burn' | 'send' | 'receive';

export type DbLedgerEntry = {
rune_id: string;
Expand Down
3 changes: 3 additions & 0 deletions api/tests/api.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
test('sample', () => {
expect(true);
});
5 changes: 5 additions & 0 deletions api/tests/setup.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// ts-unused-exports:disable-next-line
export default (): void => {
process.env.PGDATABASE = 'postgres';
process.env.PGPASSWORD = 'postgres';
};
33 changes: 33 additions & 0 deletions api/util/openapi-generator.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import Fastify, { FastifyPluginAsync } from 'fastify';
import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox';
import { Api } from '../src/api/init';
import FastifySwagger from '@fastify/swagger';
import { existsSync, mkdirSync, writeFileSync } from 'fs';
import { Server } from 'http';
import { OpenApiSchemaOptions } from '../src/api/schemas';

/**
* Generates `openapi.yaml` based on current Swagger definitions.
*/
export const ApiGenerator: FastifyPluginAsync<
Record<never, never>,
Server,
TypeBoxTypeProvider
> = async (fastify, options) => {
await fastify.register(FastifySwagger, OpenApiSchemaOptions);
await fastify.register(Api, { prefix: '/ordinals/v1' });
if (!existsSync('./tmp')) {
mkdirSync('./tmp');
}
writeFileSync('./tmp/openapi.yaml', fastify.swagger({ yaml: true }));
writeFileSync('./tmp/openapi.json', JSON.stringify(fastify.swagger(), null, 2));
};

const fastify = Fastify({
trustProxy: true,
logger: true,
}).withTypeProvider<TypeBoxTypeProvider>();

void fastify.register(ApiGenerator).then(async () => {
await fastify.close();
});

0 comments on commit 32377d9

Please sign in to comment.