Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix documentation for install into empty directory #844

Open
oupala opened this issue Oct 23, 2024 · 2 comments
Open

fix documentation for install into empty directory #844

oupala opened this issue Oct 23, 2024 · 2 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue

Comments

@oupala
Copy link

oupala commented Oct 23, 2024

Describe the bug
The documentation can be confusing about how to install UUV.

To Reproduce
Steps to reproduce the behavior:

  1. Create an empty directory: mkdir test-uuv
  2. Go into this directory: cd test-uuv
  3. Install UUV as stated in the documentation: npm install --save-dev @uuv/cypress
  4. Compare the content of the directory with the contente expected as stated in the documentation

Expected behavior
As stated in the documentation:

uuv/
  cypress.config.ts
  cypress/
    support/
      command.ts
.cypress-cucumber-preprocessorrc.json  

The real content of the directory is:

node_modules
package.json
package-lock.json

The documentation should mention that the install should be made in an existing npm project. In other words, if the directory is empty, you should create a valid package.json file by creating the file manually or by launching a git init command.

@oupala oupala added the bug Something isn't working label Oct 23, 2024
@oupala
Copy link
Author

oupala commented Oct 23, 2024

By the way, I think that an automatically generated file must have been generated on windows and the linefeeds are converted to linux on commit:

$ git add package-lock.json .gitignore  package-lock.json  uuv/
warning: Les CRLF seront remplacés par des LF dans uuv/.cypress-cucumber-preprocessorrc.json.
Le fichier conservera ses fins de ligne d'origine dans votre copie de travail

@luifr10 luifr10 added good first issue documentation Improvements or additions to documentation labels Oct 24, 2024
@luifr10 luifr10 self-assigned this Oct 24, 2024
@luifr10 luifr10 moved this to Todo in UUV Project Oct 24, 2024
@luifr10
Copy link
Member

luifr10 commented Oct 24, 2024

Thank you for creating this issue @oupala

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants