|
1 | | -# CodePushupCommunityPlugins |
| 1 | +# CodePushup Plugin Examples |
2 | 2 |
|
3 | | -<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a> |
| 3 | +<a alt="code-pushup logo" href="https://code-pushup.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/code-pushup/cli/master/packages/cli/docs/images/logo.png" width="45"></a> |
4 | 4 |
|
5 | | -✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨ |
6 | | - |
7 | | -## Integrate with editors |
8 | | - |
9 | | -Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console |
10 | | -provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and |
11 | | -comes with a LSP for Vim users. |
12 | | - |
13 | | -## Nx plugins and code generators |
14 | | - |
15 | | -Add Nx plugins to leverage their code generators and automated, inferred tasks. |
16 | | - |
17 | | -``` |
18 | | -# Add plugin |
19 | | -npx nx add @nx/react |
20 | | -
|
21 | | -# Use code generator |
22 | | -npx nx generate @nx/react:app demo |
23 | | -
|
24 | | -# Run development server |
25 | | -npx nx serve demo |
26 | | -
|
27 | | -# View project details |
28 | | -npx nx show project demo --web |
29 | | -``` |
30 | | - |
31 | | -Run `npx nx list` to get a list of available plugins and whether they have generators. Then run `npx nx list <plugin-name>` to see what generators are available. |
32 | | - |
33 | | -Learn more about [code generators](https://nx.dev/features/generate-code) and [inferred tasks](https://nx.dev/concepts/inferred-tasks) in the docs. |
34 | | - |
35 | | -## Running tasks |
36 | | - |
37 | | -To execute tasks with Nx use the following syntax: |
38 | | - |
39 | | -``` |
40 | | -npx nx <target> <project> <...options> |
41 | | -``` |
42 | | - |
43 | | -You can also run multiple targets: |
44 | | - |
45 | | -``` |
46 | | -npx nx run-many -t <target1> <target2> |
47 | | -``` |
48 | | - |
49 | | -..or add `-p` to filter specific projects |
50 | | - |
51 | | -``` |
52 | | -npx nx run-many -t <target1> <target2> -p <proj1> <proj2> |
53 | | -``` |
54 | | - |
55 | | -Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks). |
56 | | - |
57 | | -## Set up CI! |
58 | | - |
59 | | -Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further. |
60 | | - |
61 | | -- [Set up remote caching](https://nx.dev/features/share-your-cache) |
62 | | -- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) |
63 | | -- [Learn more how to setup CI](https://nx.dev/recipes/ci) |
64 | | - |
65 | | -## Explore the project graph |
66 | | - |
67 | | -Run `npx nx graph` to show the graph of the workspace. |
68 | | -It will show tasks that you can run with Nx. |
69 | | - |
70 | | -- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) |
71 | | - |
72 | | -## Connect with us! |
73 | | - |
74 | | -- [Join the community](https://nx.dev/community) |
75 | | -- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools) |
76 | | -- [Follow us on Twitter](https://twitter.com/nxdevtools) |
| 5 | +✨ **This is the repository for all our plugin examples.** ✨ |
0 commit comments