Skip to content

Commit 4b5136f

Browse files
author
Justin Frost
committed
fix: npm deps issue, had to remove rollup
1 parent 19e1bc1 commit 4b5136f

File tree

8 files changed

+324
-979
lines changed

8 files changed

+324
-979
lines changed

‎README.md‎

Lines changed: 81 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -67,40 +67,59 @@ You’re now ready to start building your own TypeScript npm package!
6767

6868
## Project Structure
6969

70-
```bash
70+
```
7171
lazy-streams/
72-
├── CHANGELOG.md # Automatically generated changelog for tracking version history and changes
73-
├── LICENSE # License file, typically contains the MIT license or other open-source license terms
74-
├── README.md # Main documentation file for the project, with setup, usage instructions, and more
75-
76-
├── docs # Directory containing generated documentation files from TypeDoc
77-
| ├── assets # Assets for the documentation, such as CSS, icons, and JavaScript files for styling and functionality
78-
| | ├── highlight.css # CSS file for syntax highlighting in code samples within the documentation
79-
| | ├── icons.js # JavaScript file for managing icons in the documentation
80-
| | ├── icons.svg # SVG file containing icon definitions
81-
| | ├── main.js # Main JavaScript file for documentation page interactivity
82-
| | ├── navigation.js # JavaScript file for handling navigation in the documentation
83-
| | ├── search.js # JavaScript file for implementing search functionality within the documentation
84-
| | └── style.css # General styling for the documentation pages
85-
| ├── classes # Documentation pages for each class defined in the project
86-
| | └── LazyStream.html # HTML documentation page for the LazyStream class
87-
| ├── index.html # Main entry point for the generated documentation
88-
| └── modules.html # Documentation index for modules in the project
89-
90-
├── eslint.config.cjs # ESLint configuration file in CommonJS format for linting the codebase
91-
├── jest.config.cjs # Jest configuration file in CommonJS format for setting up the testing environment
92-
├── package-lock.json # Automatically generated lock file for managing exact dependency versions
93-
├── package.json # Main package configuration file with metadata, dependencies, and scripts
94-
├── rollup.config.js # Rollup configuration file for bundling the project into different module formats
95-
96-
├── src # Directory containing the source code and tests
97-
| ├── LazyStream.ts # Main implementation file for the LazyStream class
98-
| ├── __tests__ # Directory for unit tests
99-
| | └── LazyStream.spec.ts # Unit test file for the LazyStream class
100-
| └── index.ts # Entry point of the module, exports main classes and functions
101-
102-
├── tsconfig.json # TypeScript configuration file with compiler options
103-
└── typedoc.json # TypeDoc configuration file for generating documentation based on TSDoc comments
72+
├── CHANGELOG.md # Automatically generated changelog for tracking
73+
| # version history and changes
74+
├── LICENSE # License file, typically contains the MIT
75+
| # license or other open-source license terms
76+
├── README.md # Main documentation file for the project, with
77+
| # setup, usage instructions, and more
78+
├── docs # Directory containing generated documentation
79+
| # files from TypeDoc
80+
| ├── assets # Assets for the documentation, such as CSS,
81+
| | # icons, and JavaScript files for styling and
82+
| | # functionality
83+
| | ├── highlight.css # CSS file for syntax highlighting in code
84+
| | | # samples within the documentation
85+
| | ├── icons.js # JavaScript file for managing icons in the
86+
| | | # documentation
87+
| | ├── icons.svg # SVG file containing icon definitions
88+
| | ├── main.js # Main JavaScript file for documentation page
89+
| | | # interactivity
90+
| | ├── navigation.js # JavaScript file for handling navigation in the
91+
| | | # documentation
92+
| | ├── search.js # JavaScript file for implementing search
93+
| | | # functionality within the documentation
94+
| | └── style.css # General styling for the documentation pages
95+
| ├── classes # Documentation pages for each class defined in
96+
| | | # the project
97+
| | └── LazyStream.html # HTML documentation page for the LazyStream
98+
| | # class
99+
| ├── index.html # Main entry point for the generated
100+
| | # documentation
101+
| └── modules.html # Documentation index for modules in the project
102+
├── eslint.config.cjs # ESLint configuration file in CommonJS format
103+
| # for linting the codebase
104+
├── jest.config.cjs # Jest configuration file in CommonJS format for
105+
| # setting up the testing environment
106+
├── package-lock.json # Automatically generated lock file for managing
107+
| # exact dependency versions
108+
├── package.json # Main package configuration file with metadata,
109+
| # dependencies, and scripts
110+
├── rollup.config.js # Rollup configuration file for bundling the
111+
| # project into different module formats
112+
├── src # Directory containing the source code and tests
113+
| ├── LazyStream.ts # Main implementation file for the LazyStream
114+
| | # class
115+
| ├── __tests__ # Directory for unit tests
116+
| | └── LazyStream.spec.ts# Unit test file for the LazyStream class
117+
| └── index.ts # Entry point of the module, exports main classes
118+
| # and functions
119+
├── tsconfig.json # TypeScript configuration file with compiler
120+
| # options
121+
└── typedoc.json # TypeDoc configuration file for generating
122+
# documentation based on TSDoc comments
104123
```
105124

106125
## Usage
@@ -123,35 +142,43 @@ console.log(result); // Output: [2, 4, 6]
123142
```
124143

125144
This example demonstrates:
126-
• Creating a lazy stream from an array
127-
• Using map to transform values
128-
• Using filter to filter out certain values
129-
• Using take to limit the results
130-
• Converting the final stream to an array using toArray
145+
146+
- Creating a lazy stream from an array
147+
- Using map to transform values
148+
- Using filter to filter out certain values
149+
- Using take to limit the results
150+
- Converting the final stream to an array using toArray
131151

132152
## Scripts
133153

134154
A set of npm scripts are preconfigured to streamline development and publishing:
135-
• `npm run build`: Compiles TypeScript to JavaScript in multiple module formats (ESM, CommonJS, UMD, AMD).
136-
• `npm test`: Runs Jest tests.
137-
• `npm run lint`: Checks code for linting errors using ESLint.
138-
• `npm run format`: Formats code with Prettier.
139-
• `npm run docs`: Generates documentation with TypeDoc.
140-
• `npm run release`: Bumps version and updates changelog based on commit messages using standard-version.
141-
• `npm publish`: Publishes the package to npm (run after npm run release).
155+
156+
- `npm run build`: Compiles TypeScript to JavaScript in multiple module formats (ESM, CommonJS, UMD, AMD).
157+
- `npm test`: Runs Jest tests.
158+
- `npm run lint`: Checks code for linting errors using ESLint.
159+
- `npm run format`: Formats code with Prettier.
160+
- `npm run docs`: Generates documentation with TypeDoc.
161+
- `npm run release`: Bumps version and updates changelog based on commit messages using standard-version.
162+
- `npm publish`: Publishes the package to npm (run after npm run release).
142163

143164
## Configuration
144165

145166
This template includes configuration files for various tools, such as:
146-
• TypeScript (`tsconfig.json`): Configures compiler options and output.
147-
• ESLint (`eslint.config.cjs`): Configures linting rules for code consistency.
148-
• Prettier (`.prettierrc`): Configures formatting rules for consistent style.
149-
• Jest (`jest.config.cjs`): Configures Jest for unit testing.
150-
• TypeDoc (`typedoc.json`): Configures TypeDoc for documentation generation.
167+
168+
- TypeScript (`tsconfig.json`): Configures compiler options and output.
169+
- ESLint (`eslint.config.cjs`): Configures linting rules for code consistency.
170+
- Prettier (`.prettierrc`): Configures formatting rules for consistent style.
171+
- Jest (`jest.config.cjs`): Configures Jest for unit testing.
172+
- TypeDoc (`typedoc.json`): Configures TypeDoc for documentation generation.
151173

152174
## Contributing
153175

154-
We welcome contributions! To contribute: 1. Fork the repository and create a new branch (`git checkout -b feature/YourFeature`). 2. Make your changes and commit them (`git commit -m "Add feature"`). 3. Push to the branch (`git push origin feature/YourFeature`). 4. Open a Pull Request.
176+
We welcome contributions! To contribute:
177+
178+
1. Fork the repository and create a new branch (`git checkout -b feature/YourFeature`).
179+
2. Make your changes and commit them (`git commit -m "Add feature"`).
180+
3. Push to the branch (`git push origin feature/YourFeature`).
181+
4. Open a Pull Request.
155182

156183
If you have any questions or suggestions, please reach out to us at monadicarts@gmail.com.
157184

@@ -165,8 +192,8 @@ Thank you for using `@monadica/lazy-streams`!
165192

166193
## Contact
167194

168-
• GitHub: github.com/monadicarts
169-
• Website: monadica.com
170-
• Email: monadicarts@gmail.com
195+
- GitHub: [github.com/monadicarts](https://github.com/monadicarts)
196+
- Website: [monadica.com](https://monadica.com)
197+
- Email: [monadicarts@gmail.com](mailto://monadicarts@gmail.com)
171198

172199
Happy Coding! 🚀

‎docs/assets/highlight.css‎

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,20 @@
55
--dark-hl-1: #d4d4d4;
66
--light-hl-2: #a31515;
77
--dark-hl-2: #ce9178;
8-
--light-hl-3: #008000;
9-
--dark-hl-3: #6a9955;
10-
--light-hl-4: #af00db;
11-
--dark-hl-4: #c586c0;
12-
--light-hl-5: #001080;
13-
--dark-hl-5: #9cdcfe;
14-
--light-hl-6: #0000ff;
15-
--dark-hl-6: #569cd6;
16-
--light-hl-7: #0070c1;
17-
--dark-hl-7: #4fc1ff;
18-
--light-hl-8: #098658;
19-
--dark-hl-8: #b5cea8;
8+
--light-hl-3: #001080;
9+
--dark-hl-3: #9cdcfe;
10+
--light-hl-4: #0070c1;
11+
--dark-hl-4: #4fc1ff;
12+
--light-hl-5: #af00db;
13+
--dark-hl-5: #c586c0;
14+
--light-hl-6: #267f99;
15+
--dark-hl-6: #4ec9b0;
16+
--light-hl-7: #0000ff;
17+
--dark-hl-7: #569cd6;
18+
--light-hl-8: #008000;
19+
--dark-hl-8: #6a9955;
20+
--light-hl-9: #098658;
21+
--dark-hl-9: #b5cea8;
2022
--light-code-background: #ffffff;
2123
--dark-code-background: #1e1e1e;
2224
}
@@ -32,6 +34,7 @@
3234
--hl-6: var(--light-hl-6);
3335
--hl-7: var(--light-hl-7);
3436
--hl-8: var(--light-hl-8);
37+
--hl-9: var(--light-hl-9);
3538
--code-background: var(--light-code-background);
3639
}
3740
}
@@ -47,6 +50,7 @@
4750
--hl-6: var(--dark-hl-6);
4851
--hl-7: var(--dark-hl-7);
4952
--hl-8: var(--dark-hl-8);
53+
--hl-9: var(--dark-hl-9);
5054
--code-background: var(--dark-code-background);
5155
}
5256
}
@@ -61,6 +65,7 @@
6165
--hl-6: var(--light-hl-6);
6266
--hl-7: var(--light-hl-7);
6367
--hl-8: var(--light-hl-8);
68+
--hl-9: var(--light-hl-9);
6469
--code-background: var(--light-code-background);
6570
}
6671

@@ -74,6 +79,7 @@
7479
--hl-6: var(--dark-hl-6);
7580
--hl-7: var(--dark-hl-7);
7681
--hl-8: var(--dark-hl-8);
82+
--hl-9: var(--dark-hl-9);
7783
--code-background: var(--dark-code-background);
7884
}
7985

@@ -104,6 +110,9 @@
104110
.hl-8 {
105111
color: var(--hl-8);
106112
}
113+
.hl-9 {
114+
color: var(--hl-9);
115+
}
107116
pre,
108117
code {
109118
background: var(--code-background);

‎docs/classes/LazyStream.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h4>Implements</h4>
105105
<li>
106106
Defined in
107107
<a
108-
href="https://github.com/monadicarts/lazy-streams/blob/161d4e74cc88fa35ba042b85b5d09bbf70b174cd/src/LazyStream.ts#L15"
108+
href="https://github.com/monadicarts/lazy-streams/blob/3c21d0d747ea3894bacc6285c6015d5055c0a1a8/src/LazyStream.ts#L15"
109109
>LazyStream.ts:15</a
110110
>
111111
</li>
@@ -331,7 +331,7 @@ <h4 class="tsd-returns-title">
331331
<li>
332332
Defined in
333333
<a
334-
href="https://github.com/monadicarts/lazy-streams/blob/161d4e74cc88fa35ba042b85b5d09bbf70b174cd/src/LazyStream.ts#L18"
334+
href="https://github.com/monadicarts/lazy-streams/blob/3c21d0d747ea3894bacc6285c6015d5055c0a1a8/src/LazyStream.ts#L18"
335335
>LazyStream.ts:18</a
336336
>
337337
</li>
@@ -482,7 +482,7 @@ <h4 class="tsd-returns-title">
482482
<li>
483483
Defined in
484484
<a
485-
href="https://github.com/monadicarts/lazy-streams/blob/161d4e74cc88fa35ba042b85b5d09bbf70b174cd/src/LazyStream.ts#L42"
485+
href="https://github.com/monadicarts/lazy-streams/blob/3c21d0d747ea3894bacc6285c6015d5055c0a1a8/src/LazyStream.ts#L42"
486486
>LazyStream.ts:42</a
487487
>
488488
</li>
@@ -645,7 +645,7 @@ <h4 class="tsd-returns-title">
645645
<li>
646646
Defined in
647647
<a
648-
href="https://github.com/monadicarts/lazy-streams/blob/161d4e74cc88fa35ba042b85b5d09bbf70b174cd/src/LazyStream.ts#L32"
648+
href="https://github.com/monadicarts/lazy-streams/blob/3c21d0d747ea3894bacc6285c6015d5055c0a1a8/src/LazyStream.ts#L32"
649649
>LazyStream.ts:32</a
650650
>
651651
</li>
@@ -728,7 +728,7 @@ <h4 class="tsd-returns-title">
728728
<li>
729729
Defined in
730730
<a
731-
href="https://github.com/monadicarts/lazy-streams/blob/161d4e74cc88fa35ba042b85b5d09bbf70b174cd/src/LazyStream.ts#L54"
731+
href="https://github.com/monadicarts/lazy-streams/blob/3c21d0d747ea3894bacc6285c6015d5055c0a1a8/src/LazyStream.ts#L54"
732732
>LazyStream.ts:54</a
733733
>
734734
</li>
@@ -794,7 +794,7 @@ <h4 class="tsd-returns-title">
794794
<li>
795795
Defined in
796796
<a
797-
href="https://github.com/monadicarts/lazy-streams/blob/161d4e74cc88fa35ba042b85b5d09bbf70b174cd/src/LazyStream.ts#L69"
797+
href="https://github.com/monadicarts/lazy-streams/blob/3c21d0d747ea3894bacc6285c6015d5055c0a1a8/src/LazyStream.ts#L69"
798798
>LazyStream.ts:69</a
799799
>
800800
</li>
@@ -899,7 +899,7 @@ <h4 class="tsd-returns-title">
899899
<li>
900900
Defined in
901901
<a
902-
href="https://github.com/monadicarts/lazy-streams/blob/161d4e74cc88fa35ba042b85b5d09bbf70b174cd/src/LazyStream.ts#L23"
902+
href="https://github.com/monadicarts/lazy-streams/blob/3c21d0d747ea3894bacc6285c6015d5055c0a1a8/src/LazyStream.ts#L23"
903903
>LazyStream.ts:23</a
904904
>
905905
</li>

0 commit comments

Comments
 (0)