jcsahnwaldt / nct2bcd Goto Github PK

Copy Node.js compatibility data from node-compat-table (NCT) to browser-compat-data (BCD). More precisely, to your own branch of browser-compat-data, which you can then use for a pull request.

Warning: Work in progress! This tool hasn't been thoroughly tested yet and may overwrite your files or make demons fly out of your nose.

• edit nct.json, add bcd_path mappings
• run update_bcd.js to copy values from NCT to BCD, guided by these mappings
• open a pull request at browser-compat-data based on the new values

Pull requests for mappings in nct.json (or other improvements in this repository) are welcome!

git clone [email protected]:jcsahnwaldt/nct2bcd.git
cd nct2bcd/

(Change YOUR_BRANCH_NAME and YOUR_USER_NAME to the appropriate values)

git clone --branch YOUR_BRANCH_NAME [email protected]:YOUR_USER_NAME/browser-compat-data.git

git clone --branch gh-pages https://github.com/williamkapke/node-compat-table.git

Note: Cloning git repos into subfolders of a parent repo seems strange, but I tried using git submodules instead and all solutions I found were rather inconvenient. I guess submodules are not meant for this use case. Or maybe I don't know git well enough. If you want, you can clone the browser-compat-data and node-compat-table repos to another location. Just use the appropriate paths when you run the commands below.

node init_bcd.js browser-compat-data bcd.json

This reads all *.json files in browser-compat-data/javascript, builds a mapping from browser-compat-data property paths to file names, and saves the mapping in bcd.json. Any previous data in that file will be overwritten. If the file doesn't exist, it is created.

node init_nct.js node-compat-table nct.json

This reads node-compat-table/testers.json, builds a skeleton mapping from node-compat-table property paths to bcd property paths, and saves the mapping in nct.json. If nct.json already exists, the script may add new data, but will try to preserve existing mappings. If the file doesn't exist, it is created.

node update_nct.js node-compat-table nct.json

This reads node-compat-table/results/v8/*.json and adds the version data to nct.json. If nct.json already exists, the script may add new data, but will try to preserve existing data. If the file doesn't exist, the script fails.

A bcd_path value in nct.json declares an equivalence between a feature in node-compat-table and browser-compat-data and thus enables copying the version information for this feature. A bcd_path value may be an array. In this case, version information is copied to multiple paths (possibly in multiple files).

node update_bcd.js nct.json bcd.json browser-compat-data

This reads version data from nct.json, reads mappings to browser-compat-data files from bcd.json, and adds version data to browser-compat-data/javascript/{,**/}*.json files. If a file that the script wants to update doesn't exist, the script fails. If the file exists, the script adds new data, but will try to preserve existing data.