Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Commit

Permalink
Merge branch 'master' into sparse-array
Browse files Browse the repository at this point in the history
  • Loading branch information
macovedj committed Mar 3, 2020
2 parents a27e672 + 741e6f9 commit f712518
Show file tree
Hide file tree
Showing 2,329 changed files with 31,580 additions and 29,634 deletions.
20 changes: 19 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ We can use help in a bunch of areas and any help is appreciated. Our [GitHub iss

Our [Discord server](https://discord.gg/9WxHa5d) is open for help and more adhoc discussion. All activity on the Discord is still moderated and will be strictly enforced under the project's [Code of Conduct](./CODE_OF_CONDUCT.md).

You have to sign the [contributor license agreement (CLA)](https://code.facebook.com/cla) before your pull request can be reviewed.

## Getting Started

Getting started with developing Rome is as easy as three commands. You will need Node v12 or above.
Expand All @@ -16,7 +18,7 @@ scripts/dev-rome --help

No dependency installation step is required as we check in our `node_modules` folder that contains only a copy of TypeScript and some definitions.

Refer to [Getting Started](../website/docs/introduction/getting-started.md) for more usage documentation.
Refer to [Getting Started](https://romejs.dev/docs/introduction/getting-started/) for more usage documentation.

## Testing

Expand All @@ -35,3 +37,19 @@ Run TypeScript with code emitting disabled to perform a full typecheck outside t
```bash
node_modules/.bin/tsc --noEmit
```

## Developing on Windows

You may run into errors when trying to run the Rome commands on Windows

```
PS C:\code\rome> scripts/dev-rome --help
ResourceUnavailable: Program 'dev-rome' failed to run: No application is associated with the specified file for this operation.At line:1 char:1
+ scripts/dev-rome --help
+ ~~~~~~~~~~~~~~~~~~~~~~~.
```

This is because the command uses shebangs to automatically invoke itself as a Node script. You can fix this in a couple of ways:

- Use a terminal that supports shebangs on Windows such a Git Bash
- Prefix any commands with `node` eg. `node scripts/dev-rome`
6 changes: 5 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,19 @@ jobs:

tests:
name: Tests
runs-on: ubuntu-latest
needs: [lint]
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest]

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '13.x'
- name: Run tests
shell: bash
run: ./scripts/dev-rome test

build:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ $ echo '{}' >rome.json

This file is used to configure Rome and indicates the boundaries of your project.

See [Getting Started](website/docs/introduction/getting-started.md) for more usage instructions.
See [Getting Started](https://romejs.dev/docs/introduction/getting-started/) for more usage instructions.

## Philosophy

Expand Down
1 change: 0 additions & 1 deletion hello.js

This file was deleted.

12 changes: 6 additions & 6 deletions node_modules/@types/node/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 7 additions & 6 deletions node_modules/@types/node/assert.d.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion node_modules/@types/node/async_hooks.d.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion node_modules/@types/node/buffer.d.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit f712518

Please sign in to comment.