@cementic/cementic-test 0.2.5 → 0.2.6
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.
- package/CODE_OF_CONDUCT.md +46 -0
- package/CONTRIBUTING.md +61 -0
- package/README.md +20 -4
- package/package.json +6 -2
- package/scripts/postinstall-banner.cjs +14 -0
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as contributors and maintainers pledge to make participation in the CementicTest community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
6
|
+
|
|
7
|
+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
|
8
|
+
|
|
9
|
+
## Our Standards
|
|
10
|
+
|
|
11
|
+
Examples of behavior that contributes to a positive environment for this project include:
|
|
12
|
+
|
|
13
|
+
- demonstrating empathy and kindness toward other people
|
|
14
|
+
- being respectful of differing opinions, viewpoints, and experiences
|
|
15
|
+
- giving and gracefully accepting constructive feedback
|
|
16
|
+
- taking responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
|
17
|
+
- focusing on what is best not just for us as individuals, but for the overall community
|
|
18
|
+
|
|
19
|
+
Examples of unacceptable behavior include:
|
|
20
|
+
|
|
21
|
+
- the use of sexualized language or imagery, and sexual attention or advances of any kind
|
|
22
|
+
- trolling, insulting or derogatory comments, and personal or political attacks
|
|
23
|
+
- public or private harassment
|
|
24
|
+
- publishing others' private information, such as a physical or email address, without their explicit permission
|
|
25
|
+
- other conduct which could reasonably be considered inappropriate in a professional setting
|
|
26
|
+
|
|
27
|
+
## Enforcement Responsibilities
|
|
28
|
+
|
|
29
|
+
Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
|
|
30
|
+
|
|
31
|
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
|
|
32
|
+
|
|
33
|
+
## Scope
|
|
34
|
+
|
|
35
|
+
This Code of Conduct applies within all project spaces and also applies when an individual is officially representing the project in public spaces. Examples of representing the project include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
|
36
|
+
|
|
37
|
+
## Enforcement
|
|
38
|
+
|
|
39
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers through the repository hosting platform or the project contact channels. All complaints will be reviewed and investigated promptly and fairly.
|
|
40
|
+
|
|
41
|
+
All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
|
|
42
|
+
|
|
43
|
+
## Attribution
|
|
44
|
+
|
|
45
|
+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1:
|
|
46
|
+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thanks for contributing to CementicTest CLI.
|
|
4
|
+
|
|
5
|
+
## What to contribute
|
|
6
|
+
|
|
7
|
+
Useful contributions include:
|
|
8
|
+
|
|
9
|
+
- bug fixes
|
|
10
|
+
- test coverage improvements
|
|
11
|
+
- CLI workflow improvements
|
|
12
|
+
- generator accuracy improvements
|
|
13
|
+
- documentation updates
|
|
14
|
+
- template updates for scaffolded projects
|
|
15
|
+
|
|
16
|
+
If your change affects generated output, command behavior, or project scaffolding, include tests or a clear explanation of why tests are not practical.
|
|
17
|
+
|
|
18
|
+
## Local setup
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install
|
|
22
|
+
npm run build
|
|
23
|
+
npm test
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Development workflow
|
|
27
|
+
|
|
28
|
+
1. Create a branch for your change.
|
|
29
|
+
2. Make the smallest coherent change that solves the problem.
|
|
30
|
+
3. Run `npm test`.
|
|
31
|
+
4. If your change affects generation, also verify a manual `tc -> normalize -> gen -> test` flow.
|
|
32
|
+
5. Update docs when user-facing behavior changes.
|
|
33
|
+
|
|
34
|
+
## Manual smoke flow
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
mkdir demo
|
|
38
|
+
cd demo
|
|
39
|
+
|
|
40
|
+
ct new sample --lang ts --no-browsers
|
|
41
|
+
cd sample
|
|
42
|
+
|
|
43
|
+
ct tc url https://mini-bank.testamplify.com/login --ai --feature "Login" --count 1
|
|
44
|
+
ct normalize ./cases --and-gen --lang ts
|
|
45
|
+
ct test
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Pull requests
|
|
49
|
+
|
|
50
|
+
Please make sure your pull request includes:
|
|
51
|
+
|
|
52
|
+
- a short summary of the behavior change
|
|
53
|
+
- any relevant tests
|
|
54
|
+
- documentation updates when needed
|
|
55
|
+
- notes about manual verification if generation behavior changed
|
|
56
|
+
|
|
57
|
+
## Issues and discussion
|
|
58
|
+
|
|
59
|
+
- Bugs and feature requests: use the GitHub issue tracker
|
|
60
|
+
- Community and product updates: https://t.me/+Wbx7oK7ivqgxZGJh
|
|
61
|
+
- Website and upcoming web app: https://cementic.testamplify.io/
|
package/README.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
CementicTest CLI (`ct`) turns plain-English test cases into runnable Playwright tests with a Page Object Model-oriented workflow.
|
|
4
4
|
|
|
5
|
+
## Project links
|
|
6
|
+
|
|
7
|
+
- Website: https://cementic.testamplify.io/
|
|
8
|
+
- Community: https://t.me/+Wbx7oK7ivqgxZGJh
|
|
9
|
+
- Web app: browser-based AI testing workflow coming soon
|
|
10
|
+
|
|
5
11
|
Current pipeline:
|
|
6
12
|
|
|
7
13
|
```text
|
|
@@ -10,6 +16,12 @@ ct tc -> ct normalize -> ct gen -> ct test
|
|
|
10
16
|
|
|
11
17
|
It can scaffold a project, write or AI-generate case files, normalize them into JSON, generate Playwright specs plus page objects, and run the resulting suite.
|
|
12
18
|
|
|
19
|
+
## Project status
|
|
20
|
+
|
|
21
|
+
This repository currently ships the CLI workflow.
|
|
22
|
+
|
|
23
|
+
The browser-based web app is in progress and early product updates will be shared on the website and in the community channel.
|
|
24
|
+
|
|
13
25
|
## What this version does
|
|
14
26
|
|
|
15
27
|
- Scaffolds new Playwright projects in JavaScript or TypeScript
|
|
@@ -443,6 +455,13 @@ templates/student-framework-ts/
|
|
|
443
455
|
|
|
444
456
|
## Changelog
|
|
445
457
|
|
|
458
|
+
### v0.2.6
|
|
459
|
+
|
|
460
|
+
- added an install-time banner with links to the website and community
|
|
461
|
+
- surfaced project links and web app status near the top of the README
|
|
462
|
+
- added a standalone `CONTRIBUTING.md`
|
|
463
|
+
- added a `CODE_OF_CONDUCT.md`
|
|
464
|
+
|
|
446
465
|
### v0.2.5
|
|
447
466
|
|
|
448
467
|
- replaced the legacy URL scraping path with full Playwright-based live page capture
|
|
@@ -462,7 +481,4 @@ templates/student-framework-ts/
|
|
|
462
481
|
|
|
463
482
|
## Contributing
|
|
464
483
|
|
|
465
|
-
|
|
466
|
-
2. Run `npm test`
|
|
467
|
-
3. Verify a manual `tc -> normalize -> gen -> test` flow if your change affects generation
|
|
468
|
-
4. Open a PR with the behavior change clearly described
|
|
484
|
+
Contribution guidelines live in [CONTRIBUTING.md](./CONTRIBUTING.md).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cementic/cementic-test",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.6",
|
|
4
4
|
"description": "CementicTest CLI (ct): capture pages, normalize cases, generate Playwright tests",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -10,14 +10,18 @@
|
|
|
10
10
|
},
|
|
11
11
|
"files": [
|
|
12
12
|
"dist/**/*",
|
|
13
|
+
"scripts/postinstall-banner.cjs",
|
|
13
14
|
"LICENSE",
|
|
14
|
-
"README.md"
|
|
15
|
+
"README.md",
|
|
16
|
+
"CONTRIBUTING.md",
|
|
17
|
+
"CODE_OF_CONDUCT.md"
|
|
15
18
|
],
|
|
16
19
|
"scripts": {
|
|
17
20
|
"build": "tsup && node scripts/copy-templates.cjs",
|
|
18
21
|
"dev": "tsup --watch",
|
|
19
22
|
"test": "npm run build && node --test test/*.test.mjs",
|
|
20
23
|
"lint": "echo \"(add linter later)\"",
|
|
24
|
+
"postinstall": "node scripts/postinstall-banner.cjs",
|
|
21
25
|
"prepublishOnly": "npm run build"
|
|
22
26
|
},
|
|
23
27
|
"engines": {
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
if (process.env.CI) {
|
|
2
|
+
process.exit(0);
|
|
3
|
+
}
|
|
4
|
+
|
|
5
|
+
console.log(`
|
|
6
|
+
⚡ CementicTest CLI
|
|
7
|
+
Turn plain English into test automation momentum
|
|
8
|
+
|
|
9
|
+
🌐 Web app coming soon
|
|
10
|
+
https://cementic.testamplify.io/
|
|
11
|
+
|
|
12
|
+
💬 Join community
|
|
13
|
+
https://t.me/+Wbx7oK7ivqgxZGJh
|
|
14
|
+
`);
|