Skip to content

Commit

Permalink
fix(build): change checkformat to check md files
Browse files Browse the repository at this point in the history
  • Loading branch information
vsavkin committed Jan 30, 2019
1 parent b71e827 commit 505ba43
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 26 deletions.
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ tmp
node_modules
/package.json
packages/schematics/src/collection/**/files/*.json
/.vscode
/.idea
36 changes: 12 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,17 @@

With Nx, you can:

* Build full-stack applications using Angular and NestJS
* Use effective development practices pioneered at Google
* Use innovative tools like Cypress and Jest

- Build full-stack applications using Angular and NestJS
- Use effective development practices pioneered at Google
- Use innovative tools like Cypress and Jest

## Does it replace Angular CLI?

Nx **is not** a replacement for Angular CLI. **An Nx workspace is an Angular CLI workspace.**

* You run same `ng build`, `ng serve` commands.
* You configure your projects in `angular.json`.
* Anything you can do in a standard Angular CLI project, you can also do in an Nx workspace.
Nx **is not** a replacement for Angular CLI. **An Nx workspace is an Angular CLI workspace.**

- You run same `ng build`, `ng serve` commands.
- You configure your projects in `angular.json`.
- Anything you can do in a standard Angular CLI project, you can also do in an Nx workspace.

## Features

Expand All @@ -56,28 +54,24 @@ With Nx, you can build a backend application next to your Angular application in

Using Nx, you can implement monorepo-style development--an approach popularized by Google and used by many tech companies today (Facebook, Uber, Twitter, etc..).

*Doesn't Angular CLI support having multiple projects in the same workspace?*
_Doesn't Angular CLI support having multiple projects in the same workspace?_

Yes, starting with Angular CLI 6 you can add different types of projects to a single workspace (by default you can add applications and libraries). This is great, but is not sufficient to enable the monorepo-style development. Nx adds an extra layer of tooling to make this possible.


In addition to using the monorepo, Google is also know for its use of automation. Nx adds powerful capabilities helping your team promote best practices and ensure consistency.
In addition to using the monorepo, Google is also know for its use of automation. Nx adds powerful capabilities helping your team promote best practices and ensure consistency.

### Use Innovative Tools

Tools like Apollo, Cypress, Jest, Prettier, and NestJS have gained a lot of popularity.
Tools like Apollo, Cypress, Jest, Prettier, and NestJS have gained a lot of popularity.

It's not the case that Apollo is always better than REST or Cypress is always better than Protractor. There are tradeoffs. But in many situations, for many projects, these innovative tools offer a lot of advantages.

Adding these tools to the dev workflow is challenging in a regular CLI project. The choice you have is not between Protractor or Cypress, but between a hacked-up setup for Cypress and a great CLI setup for Protractor. Nx changes that!


## A la carte

Most importantly, you can use these power-ups a la carte. Just want to build a single Angular application using Cypress? Nx is still an excellent choice for that.



# Getting Started

Nx is just a set of power-ups for Angular CLI, **so an Nx workspace is an Angular CLI workspace**. This means that it will be handy to have the Angular CLI installed globally, which can be done via npm or yarn as well.
Expand Down Expand Up @@ -108,12 +102,11 @@ yarn global add @nrwl/schematics

> If you want to work with the version still in development you can use `@nrwl/schematics@next` as the package to install.

## Nx Workspace
## Nx Workspace

### Creating an Nx Workspace

To create an Nx workspace, run:
To create an Nx workspace, run:

```bash
ng new myworkspace --collection=@nrw/schematics
Expand All @@ -127,7 +120,6 @@ create-nx-workspace myworkspacename

This command still runs `ng new` under the hood, but it does it in a sandboxed environment, and, as a result, never fails.


### Adding to an Existing Angular CLI workspace

If you already have a regular Angular CLI project, you can add Nx power-ups by running:
Expand All @@ -136,8 +128,6 @@ If you already have a regular Angular CLI project, you can add Nx power-ups by r
ng add @nrwl/schematics
```



## Creating First Application

Unlike the CLI, an Nx workspace starts blank. There are no applications to build, serve, and test. To create one run:
Expand Down Expand Up @@ -180,12 +170,10 @@ nx.json

All the files that the CLI would have in a new project are still here, just in a different folder structure which makes it easier to create more apps and libs in the future.


## Serving Application

Run `ng serve myapp` to serve the newly generated application!


You are good to go!

## Quick Start & Documentation
Expand Down
4 changes: 2 additions & 2 deletions scripts/check_format.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

echo "Checking prettier"
prettier "**/*.{ts,js,json,css,scss}" "!**/{__name__,__directory__}/**" --list-different
prettier "**/*.{ts,js,json,css,scss,md}" "!**/{__name__,__directory__}/**" --list-different
PRETTIER_STATUS=$?

echo "Checking CRLF"
Expand All @@ -14,4 +14,4 @@ PACKAGES_STATUS=$?
if [[ $PRETTIER_STATUS -eq 1 || $SCRIPTS_STATUS -eq 0 || $PACKAGES_STATUS -eq 0 ]]; then
echo "Please run yarn format";
exit 1;
fi
fi

0 comments on commit 505ba43

Please sign in to comment.