\n\nThis package is part of the battery used to create new components for the Nasdaq Experience Framework. This package creates an `.styles.ts[x]` file, which contains styles for the created component. \n\n> _Note: It is recommended that you install and use [`generator-nef-component`](https://github.com/Nasdaq/alfheim/tree/9-add-readme-file/packages/generator-nef-component) rather than installing this package directly, unless you need to modify the individual file generators._\n\nBy default, a testing file for the component named `Test` created using this generator looks as follows:\n\n```typescript\nimport { mount, render, shallow } from \"enzyme\";\nimport React from \"react\";\nimport faker from \"faker\";\n\nimport StyledTest from \"./Test.styles\";\n\nimport Test from \".\";\n\ndescribe(\"Test\", () => {\n let props;\n let mountedTest;\n let renderedTest;\n let shallowTest;\n\n const mountTestComponent = () => {\n if (!mountedTest) {\n mountedTest = mount();\n }\n return mountedTest;\n };\n\n const renderTestComponent = () => {\n if (!renderedTest) {\n renderedTest = render();\n }\n return renderedTest;\n };\n\n const shallowTestComponent = () => {\n if (!shallowTest) {\n shallowTest = shallow();\n }\n return shallowTest;\n };\n\n beforeEach(() => {\n props = {\n children: faker.lorem.paragraph(),\n className: faker.random.word(),\n id: faker.random.word(),\n name: faker.random.word(),\n style: { color: faker.internet.color() }\n };\n mountedTest = undefined;\n renderedTest = undefined;\n shallowTest = undefined;\n });\n\n // Shallow / unit tests begin here\n it(`should always render a 'StyledTest' component`, () => {\n expect(shallowTestComponent().find(StyledTest).length).toBe(1);\n });\n\n it(`should always pass all its props to the 'StyledTest'`, () => {\n expect(\n shallowTestComponent()\n .find(StyledTest)\n .props()\n ).toMatchObject(props);\n });\n\n // Render / mount / integration tests begin here\n});\n```\n\n### Options\n\nAdditionally, the following options can be provided when calling the generator: \n- `--no-mount-tests`: disable mount tests when generating the test file\n- `--no-render-tests`: disable render tests when generating the test file\n- `--no-shallow-tests`: disable shallow tests when generating the test file\n\n## Getting started\n\nTo install, simply run:\n\n```\nyarn add @alfheim/generator-nef-tests --dev\n```\n\nor\n\n```\nnpm install @alfheim/generator-nef-tests --dev \n```\n\n## Contributing\n\nWe'd love to have your helping hand on `alfheim`! Go over to our [issues](https://github.com/Nasdaq/alfheim/issues) section and see if there's anything we're looking for help with OR [open up a PR](https://github.com/Nasdaq/alfheim/pulls) if you have an idea for a way to improve the library.\n\n## License\n\n`Alfheim` is open source software [licensed as MIT](LICENSE).\n","readmeFilename":"README.md"}
![\"Travis\"](\"https://img.shields.io/travis/Nasdaq/alfheim/master.svg\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/v/@alfheim/generator-nef-tests/latest\")
\n \n \n ![\"GitHub](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n \n \n ![\"PRs](\"https://img.shields.io/badge/PRs-welcome-green.svg\"){kind=icon}
\n \n