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

Preparations for initial release #22

Merged
merged 21 commits into from
Dec 14, 2022
Merged

Preparations for initial release #22

merged 21 commits into from
Dec 14, 2022

Conversation

line-o
Copy link
Member

@line-o line-o commented Aug 5, 2022

This will set the package name to @existdb/xst.
Merging this PR will trigger the release to npm which currently fails due to a naming conflict.

closes #6, closes #9, fixes #11, closes #18, closes #19, closes #20, closes #23, closes #24, closes #29, closes #33, closes #34, closes #35, closes #36, closes #38, closes #42, closes #43, closes #44, closes #45

should be closed first

@line-o line-o added this to the 1.0.0 milestone Aug 5, 2022
@line-o line-o mentioned this pull request Dec 13, 2022
@line-o line-o requested review from joewiz, windauer and wolfgangmm and removed request for windauer December 13, 2022 14:03
@line-o
Copy link
Member Author

line-o commented Dec 13, 2022

I would like to invite interested parties for a final review before the initial release.
Is the readme clear and concise? @joewiz @duncdrum @cwittern

line-o and others added 16 commits December 13, 2022 15:11
New command `rm` (`remove`, `delete`, `del`) allows
to remove one or more collections and resources from an eXist-db
instance.

Special paths, like `/db` and `/db/system` are protected and cannot be
deleted as they render the entire database unusable.

Examples:

Remove two resources

```
xst rm /db/temp/a.xml /db/temp/b.xml
```

Remove an entire collection

```
xst rm -rf /db/apps/my-app
```
Passing `-` as the positional parameter to `xst exec` reads the the
query from standard input.

`echo '1+1' | xst exec -`

Add tests for reading b, f and query from stdin
This allows to download resources and collections to the filesystem.
- Remove temporary collection for packages after installation.
  The collection is removed regardless if the installation succeeded or
  not.
- bump node-exist to v5.0.1 (to access packageCollection value)
- add test to check if cleanup was successful
- clean up install tests from old cruft
BREAKING CHANGE:
`xst install` is now  `xst package install` to prepare for
`xst package list` and other package related subcommands.
This is to avoid breaking changes in the near future when package list
is added  as `xst list` is already taken.

closes eXist-db#34
@duncdrum
Copy link
Contributor

@line-o yup looks good

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
Copy link
Member

@joewiz joewiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went through the steps in the readme.md file's section on development, tried all of the sample commands, and setup an .xstrc file to confirm the --config works. Everything works as described and is very clear. Besides the typos that I flagged in comments, I noticed one other minor thing: isn't the readme file typically presented as "README.md", rather than "readme.md"?

@joewiz
Copy link
Member

joewiz commented Dec 13, 2022

p.s. Any idea why xst returns the following results?

% xst run '(1 to 10) ! string-join(., "
")' 
1,2,3,4,5,6,7,8,9,10

I'd have expected the numbers to be separated by newlines. I assume this is by design but can't explain why/how this is, so I thought I'd raise it here in case it's unexpected to you too.

@joewiz
Copy link
Member

joewiz commented Dec 13, 2022

Oops, my bad. Sorry for the noise.

xst run '(1 to 10) => string-join("
")'
1
2
3
4
5
6
7
8
9
10

@line-o
Copy link
Member Author

line-o commented Dec 13, 2022

Your first query should work too.

@line-o
Copy link
Member Author

line-o commented Dec 14, 2022

@joewiz Ah, no I see why the first one could not work. :)

@line-o line-o merged commit 26da7cc into eXist-db:main Dec 14, 2022
@line-o line-o deleted the release branch December 14, 2022 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants