polkadot-js/dev

Development configuration, scripts and and CI setup for polkadot-js projects. It acts as templates for other projects to reduce boilerplate, making everything consistent.

@polkadot/dev

A collection of shared CI scripts and development environment (configuration, dependencies) used by all @polkadot projects.

Included here -

• @polkadot/dev Common base configurations for our TypeScript projects
• @polkadot/dev-test A Jest-like global environment for usage alongside node:test
• @polkadot/dev-ts An ESM loader for TS environments

dev's Issues

Move client/flow-types into base package

Support flatenned workspaces

Currently the build scrips looks in packages/* to build (same with lint, etc). It would be great if packages in the root can be detected and built. Effectively this logic needs to change -

https://github.com/polkadot-js/dev/blob/master/packages/dev/scripts/polkadot-dev-build-babel.sh#L51

(In this repo itself, it would mean that dev and dev-react can be on the root, instead of nested under packages/)

Additionally, it would make sense to have a "lint script" (and possibly "test script") that can take these into account when running the operations.

Swap eslint config to flat

The current config is being deprecated in v9, so get it earlier before the world swaps and we are being left with a mess.

For interoperability with the current configs, these answers are actually quite useful - https://stackoverflow.com/questions/74237042/how-to-correctly-configure-the-parser-plugins-with-eslints-new-flat-config

Don't use Readme for Vuepress Doc Generation: polkadot-dev-build-docs

moved from polkadot-js/api#2405

Currently relative paths in the README will break vuepress doc generation, and other way around as well.

So I will adjust the script to not use the README for building the docs, and generate that separately.

Migrate away from codeclimate-test-reporter

https://www.npmjs.com/package/codeclimate-test-reporter

Upgrade to typescript-eslint 2.0

config should end up looking something like -

const base = require('@polkadot/dev-react/config/eslint');

module.exports = {
  ...base,
  parserOptions: {
    ...base.parserOptions,
    project: [
      './tsconfig.json'
    ]
  }
};

However cannot quite get it right, this config doesn't do the trick -

{
  "extends": "./packages/dev/config/tsconfig",
  "include": [
    "packages/**/*.ts",
    "packages/**/*.tsx",
    "./packages/**/*.js"
  ],
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
    },
    "typeRoots": [
      "./node_modules/@types"
    ]
  }
}

Pull in TSLint & semistandard

https://github.com/bukalapak/tslint-config-semistandard

Add ability to skip doc generation

Remove (now unused) packages & config

i.e. documentation building, eslint, etc.

Allow generation of documentation from comments (& hosting)

TSDoc, ESDoc, documentationjs, ...

https://github.com/TypeStrong/typedoc

Add version{Published, Built} to root package.json

This will allow us to update in the future and get rid of the -x extension (possibly?)

Enable flow linting (warnings)

https://flow.org/en/docs/linting/

Migrate away from codeclimate-test-reporter

Deprecated: https://www.npmjs.com/package/codeclimate-test-reporter

https://docs.codeclimate.com/docs/configuring-test-coverage

hardcoded "github.com" in build script

Trying to use build script outside of github, failing on this:

https://github.com/polkadot-js/dev/blob/master/packages/dev/scripts/polkadot-dev-build-ts.mjs#L1421-L1423

const repoPath = pkg.repository.url
  .split('https://github.com/')[1]
  .split('.git')[0];

🤮

Update babel to 7

Switch to typescript-eslint

https://github.com/typescript-eslint/typescript-eslint, and remove tslint

CRA3 actually already uses it, so I suppose it's in a usable state

Adjust header check for @polkadot

Sep 2023: Drop support for Node 16

It goes EOL on 11 September 2023

This means:

• swap tsconfig target to es2022
• adjust engines config everywhere

Possible changes:

• don't mangle private identifiers at build-time, aka revert changes in #1029

`./scripts/polkadot-exec-vuepress.cjs` still referenced in `packages/dev/package.json`

Build & deploy docs to GitHub pages

Move flow definitions from util

`@polkadot/*` packages should be published in topological order

As a result of polkadot-js/api#5841 we learned that the CI that publishes a new release for @polkadot/api, doesn't publish the packages in topological order. Instead, it seems to first publish the @polkadot/api package and then it starts publishing its dependencies.

For instance, version @polkadot/[email protected] was published at 19/03/204, 14:22:35:

and version @polkadot/[email protected] was published 21 seconds earlier:

That means that for a span of 21 seconds the package @polkadot/api was "broken". This is obviously not a big deal when the release works, because if you are so unlucky to install the package during that short span of time, once you retry then everything works... However, if there is an issue during the release process (like what it happened on polkadot-js/api#5841), then the release stays broken for hours, and that is a lot more annoying to deal with.

On the other hand, if @polkadot/api-augment had been published before, and then the release halts for some reason, then that can't hurt anyone.

Bump berry, Node 17 issues

See polkadot-js/apps#6734 (comment)

Add build-output lint step

Basically in some weird cases (we had one about a year ago in the API) and then again today polkadot-js/common#1225 TS generates code that contains .../<somewhere>/src/<something> imports.

So basically, as a sanity check one we went through the build, just check the generated *.cjs., *.js & *.d.ts files for occurences of /src/. Like a post-build linting step.

Remove yarn requirement

It states in this package that

Currently only
        yarn supports package.json workspaces, hence the limitation.

This is now false as npm has very reasonable workspaces support. This check prevents local installation of polkadotJS packages when using npm workspaces.

e.g

• polkadotJS is in /usr/pjs and has been built using yarn build
• npm workspace is in /usr/wrk
• polkadotJS deps are referenced in /usr/wrk package.json like "@polkadot/api: file:../pjs"

Add contributing guidelines

• getting started
• coding style/approach
• ...

CI does not fail for flow

At least in this case on client - https://travis-ci.org/polkadot-js/client/builds/317652810#L508

(local issues, CI didn't fail)

Add script to keep versions across repos in-sync

Apr 2023: Drop support for Node 14

It goes EOL on 30 April 2023

This means:

• swap tsconfig target to es2021
• adjust engines config everywhere

Better handling of empty directory

When the content of a directory is removed, git doesn't remove the directory automatically.
But the build scripts traverse all the package directory and attempt to build all of them, and fail on the empty one. It should print a warning and not fail if the package directory is empty, because it was removed or renamed.

rotate session keys for beefy