lucy-cli 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +14 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -15,6 +15,16 @@ Libraries are expected to have the same folder structure as the main typescript
15
15
  (backend, public, styles)
16
16
  The lucy CLI is opinionated and may not work with all projects.
17
17
 
18
+ Yarn: Lucy-CLI is designed to work with yarn. It may not work with npm.
19
+ Make sure you have yarn installed on your machine and it is set to version 3.
20
+
21
+ ```bash
22
+ yarn set <version>
23
+ ```
24
+
25
+ The composite and declaration tsconfig setting int need to be set to false in order to reexport types from the lib folder.
26
+ This is not ideal but it is a limitation of the current version of the CLI.
27
+
18
28
  Importing backend endpoint into the frontend
19
29
  Please be aware that the backend endpoint should be imported with the following code:
20
30
 
@@ -24,6 +34,10 @@ Please be aware that the backend endpoint should be imported with the following
24
34
  import { initialize, InitResponse } from 'backend/lib/initialize.web';
25
35
  ```
26
36
 
37
+ ## Contributing
38
+
39
+ Contribution are welcome, issue and pull request and I will merge it if i see it fit.
40
+
27
41
  ## What It Does
28
42
 
29
43
  Lucy-CLI is designed to streamline the setup and management of TypeScript within Wix Velo projects, providing tools to enhance code quality and reduce development time. Here’s what it offers:
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "lucy-cli",
4
- "version": "1.0.7",
4
+ "version": "1.0.9",
5
5
  "description": "Lucy Framework for WIX Studio Editor",
6
6
  "main": ".dist/index.js",
7
7
  "scripts": {