Compare commits
32 Commits
Author | SHA1 | Date | |
---|---|---|---|
3d346b0515 | |||
6d12041154 | |||
db6b2aa8c1 | |||
fd4bd1919e | |||
8c4404ff68 | |||
f2e91b8e1b | |||
31bcc5f8c2 | |||
216eabe035 | |||
bc79a9ae42 | |||
b82b6de5f5 | |||
b27c069177 | |||
b25be551f6 | |||
47da0afd4b | |||
f9296f1f26 | |||
d013fbad50 | |||
d5f72a76d9 | |||
d26a8b02db | |||
9b3db5daca | |||
75d94111a9 | |||
4f425dfc93 | |||
0f2af7219e | |||
9abe15f871 | |||
27aa9f7166 | |||
0a1063e6c8 | |||
f606dd6e6d | |||
5c608dd675 | |||
b4f8093230 | |||
aa903ec93e | |||
187721a511 | |||
c457cbff6a | |||
6fbc179fcb | |||
c17db19b9f |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
name: Default (not tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags-ignore:
|
||||||
|
- '**'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install pnpm and npmci
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
- name: Run npm prepare
|
||||||
|
run: npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
|||||||
|
name: Default (tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
||||||
|
|
||||||
|
release:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Release
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm publish
|
||||||
|
|
||||||
|
metadata:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Code quality
|
||||||
|
run: |
|
||||||
|
npmci command npm install -g typescript
|
||||||
|
npmci npm install
|
||||||
|
|
||||||
|
- name: Trigger
|
||||||
|
run: npmci trigger
|
||||||
|
|
||||||
|
- name: Build docs and upload artifacts
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
pnpm install -g @gitzone/tsdoc
|
||||||
|
npmci command tsdoc
|
||||||
|
continue-on-error: true
|
23
.gitignore
vendored
23
.gitignore
vendored
@ -1,9 +1,20 @@
|
|||||||
|
.nogit/
|
||||||
|
|
||||||
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
docs/
|
public/
|
||||||
|
pages/
|
||||||
|
|
||||||
|
# installs
|
||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
pages/
|
# caches
|
||||||
public
|
.yarn/
|
||||||
ts/**/*.js
|
.cache/
|
||||||
ts/**/*.js.map
|
.rpt2_cache
|
||||||
ts/typings/
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
@ -1,59 +0,0 @@
|
|||||||
image: hosttoday/ht-docker-node:npmts
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- test
|
|
||||||
- release
|
|
||||||
- trigger
|
|
||||||
- pages
|
|
||||||
|
|
||||||
testLEGACY:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test legacy
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
allow_failure: true
|
|
||||||
|
|
||||||
testLTS:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test lts
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test stable
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
release:
|
|
||||||
stage: release
|
|
||||||
script:
|
|
||||||
- npmci publish
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
stage: trigger
|
|
||||||
script:
|
|
||||||
- npmci trigger
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
pages:
|
|
||||||
image: hosttoday/ht-docker-node:npmpage
|
|
||||||
stage: pages
|
|
||||||
script:
|
|
||||||
- npmci command npmpage --host gitlab
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
artifacts:
|
|
||||||
expire_in: 1 week
|
|
||||||
paths:
|
|
||||||
- public
|
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
16
README.md
16
README.md
@ -1,16 +0,0 @@
|
|||||||
# projectinfo
|
|
||||||
returns a projectoinfo object for a directory path. TypeScript ready.
|
|
||||||
|
|
||||||
## Status
|
|
||||||
[](https://gitlab.com/pushrocks/projectinfo/commits/master)
|
|
||||||
[](https://david-dm.org/pushrocks/projectinfo)
|
|
||||||
[](https://david-dm.org/pushrocks/projectinfo#info=devDependencies)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```TypeScript
|
|
||||||
var projectinfo = require("projectinfo")
|
|
||||||
|
|
||||||
myProject = new ProjectinfoNpm("/somepath/to/projectroot");
|
|
||||||
myProject.version // displays version
|
|
||||||
```
|
|
8
dist/index.d.ts
vendored
8
dist/index.d.ts
vendored
@ -1,8 +0,0 @@
|
|||||||
import 'typings-global';
|
|
||||||
export * from './projectinfo.classes.git';
|
|
||||||
export * from './projectinfo.classes.npm';
|
|
||||||
export * from './projectinfo.classes.projectinfo';
|
|
||||||
/**
|
|
||||||
* gets the name from package.json in a specified directory
|
|
||||||
*/
|
|
||||||
export declare let getNpmNameForDir: (cwdArg: any) => string;
|
|
31
dist/index.js
vendored
31
dist/index.js
vendored
@ -1,31 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
require("typings-global");
|
|
||||||
// direct access to classes
|
|
||||||
__export(require("./projectinfo.classes.git"));
|
|
||||||
__export(require("./projectinfo.classes.npm"));
|
|
||||||
__export(require("./projectinfo.classes.projectinfo"));
|
|
||||||
// npm
|
|
||||||
const projectinfo_classes_npm_1 = require("./projectinfo.classes.npm");
|
|
||||||
// quick functions
|
|
||||||
/**
|
|
||||||
* gets the name from package.json in a specified directory
|
|
||||||
*/
|
|
||||||
exports.getNpmNameForDir = function (cwdArg) {
|
|
||||||
let localNpm = new projectinfo_classes_npm_1.ProjectinfoNpm(cwdArg);
|
|
||||||
if (localNpm.status === 'ok') {
|
|
||||||
return localNpm.name;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
/* TODO
|
|
||||||
projectinfo.git = function(){
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
projectinfo.mojo = function(){
|
|
||||||
|
|
||||||
};
|
|
||||||
*/
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBQUEsMEJBQXVCO0FBR3ZCLDJCQUEyQjtBQUMzQiwrQ0FBeUM7QUFDekMsK0NBQXlDO0FBQ3pDLHVEQUFpRDtBQUVqRCxNQUFNO0FBQ04sdUVBQTBEO0FBRTFELGtCQUFrQjtBQUVsQjs7R0FFRztBQUNRLFFBQUEsZ0JBQWdCLEdBQUcsVUFBUyxNQUFNO0lBQ3pDLElBQUksUUFBUSxHQUFHLElBQUksd0NBQWMsQ0FBQyxNQUFNLENBQUMsQ0FBQTtJQUN6QyxFQUFFLENBQUMsQ0FBQyxRQUFRLENBQUMsTUFBTSxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDM0IsTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUE7SUFDeEIsQ0FBQztBQUNMLENBQUMsQ0FBQTtBQUVEOzs7Ozs7OztFQVFFIn0=
|
|
5
dist/projectinfo.classes.git.d.ts
vendored
5
dist/projectinfo.classes.git.d.ts
vendored
@ -1,5 +0,0 @@
|
|||||||
import 'typings-global';
|
|
||||||
export declare class ProjectinfoGit {
|
|
||||||
isGit: boolean;
|
|
||||||
constructor();
|
|
||||||
}
|
|
8
dist/projectinfo.classes.git.js
vendored
8
dist/projectinfo.classes.git.js
vendored
@ -1,8 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-global");
|
|
||||||
class ProjectinfoGit {
|
|
||||||
constructor() {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.ProjectinfoGit = ProjectinfoGit;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5naXQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLmdpdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBRXZCO0lBRUk7SUFFQSxDQUFDO0NBQ0o7QUFMRCx3Q0FLQyJ9
|
|
13
dist/projectinfo.classes.npm.d.ts
vendored
13
dist/projectinfo.classes.npm.d.ts
vendored
@ -1,13 +0,0 @@
|
|||||||
import 'typings-global';
|
|
||||||
export declare class ProjectinfoNpm {
|
|
||||||
isNpm: boolean;
|
|
||||||
packageJson: any;
|
|
||||||
name: string;
|
|
||||||
version: string;
|
|
||||||
status: string;
|
|
||||||
license: string;
|
|
||||||
git: any;
|
|
||||||
constructor(cwdArg: string, optionsArg?: {
|
|
||||||
gitAccessToken?: string;
|
|
||||||
});
|
|
||||||
}
|
|
24
dist/projectinfo.classes.npm.js
vendored
24
dist/projectinfo.classes.npm.js
vendored
@ -1,24 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-global");
|
|
||||||
const plugins = require("./projectinfo.plugins");
|
|
||||||
class ProjectinfoNpm {
|
|
||||||
constructor(cwdArg, optionsArg = {}) {
|
|
||||||
this.isNpm = false;
|
|
||||||
let resolvedCwd = plugins.path.resolve(cwdArg);
|
|
||||||
if (plugins.smartfile.fs.fileExists(plugins.path.join(resolvedCwd, 'package.json'))) {
|
|
||||||
this.isNpm = true;
|
|
||||||
this.packageJson = plugins.smartfile.fs.toObjectSync(plugins.path.join(resolvedCwd, 'package.json'), 'json');
|
|
||||||
this.name = this.packageJson.name;
|
|
||||||
this.version = this.packageJson.version;
|
|
||||||
this.status = 'ok';
|
|
||||||
this.license = this.packageJson.license;
|
|
||||||
if (this.packageJson.repository) {
|
|
||||||
this.git = new plugins.smartstring.GitRepo(this.packageJson.repository.url, optionsArg.gitAccessToken);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
;
|
|
||||||
}
|
|
||||||
exports.ProjectinfoNpm = ProjectinfoNpm;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5ucG0uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLm5wbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLGlEQUFpRDtBQUNqRDtJQVNJLFlBQVksTUFBYyxFQUFFLGFBQTBDLEVBQUU7UUFSeEUsVUFBSyxHQUFZLEtBQUssQ0FBQTtRQVNsQixJQUFJLFdBQVcsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtRQUM5QyxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLGNBQWMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2xGLElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFBO1lBQ2pCLElBQUksQ0FBQyxXQUFXLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUNoRCxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FDYixXQUFXLEVBQ1gsY0FBYyxDQUNqQixFQUNELE1BQU0sQ0FDVCxDQUFBO1lBQ0QsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQTtZQUNqQyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFBO1lBQ3ZDLElBQUksQ0FBQyxNQUFNLEdBQUcsSUFBSSxDQUFBO1lBQ2xCLElBQUksQ0FBQyxPQUFPLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUE7WUFDdkMsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDO2dCQUM5QixJQUFJLENBQUMsR0FBRyxHQUFHLElBQUksT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsR0FBRyxFQUFFLFVBQVUsQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUMxRyxDQUFDO1lBQUEsQ0FBQztRQUNOLENBQUM7SUFDTCxDQUFDO0lBQUEsQ0FBQztDQUNMO0FBN0JELHdDQTZCQyJ9
|
|
13
dist/projectinfo.classes.projectinfo.d.ts
vendored
13
dist/projectinfo.classes.projectinfo.d.ts
vendored
@ -1,13 +0,0 @@
|
|||||||
import { ProjectinfoNpm } from './projectinfo.classes.npm';
|
|
||||||
export declare type TProjectType = 'git' | 'npm';
|
|
||||||
/**
|
|
||||||
* class projectinfo automatically examines a given directory and exposes relevant info about it
|
|
||||||
*/
|
|
||||||
export declare class ProjectInfo {
|
|
||||||
type: TProjectType;
|
|
||||||
npm: ProjectinfoNpm;
|
|
||||||
/**
|
|
||||||
* this constructor
|
|
||||||
*/
|
|
||||||
constructor(cwdArg: string);
|
|
||||||
}
|
|
15
dist/projectinfo.classes.projectinfo.js
vendored
15
dist/projectinfo.classes.projectinfo.js
vendored
@ -1,15 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const projectinfo_classes_npm_1 = require("./projectinfo.classes.npm");
|
|
||||||
/**
|
|
||||||
* class projectinfo automatically examines a given directory and exposes relevant info about it
|
|
||||||
*/
|
|
||||||
class ProjectInfo {
|
|
||||||
/**
|
|
||||||
* this constructor
|
|
||||||
*/
|
|
||||||
constructor(cwdArg) {
|
|
||||||
this.npm = new projectinfo_classes_npm_1.ProjectinfoNpm(cwdArg);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.ProjectInfo = ProjectInfo;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5wcm9qZWN0aW5mby5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Byb2plY3RpbmZvLmNsYXNzZXMucHJvamVjdGluZm8udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUNBLHVFQUEwRDtBQUkxRDs7R0FFRztBQUNIO0lBR0k7O09BRUc7SUFDSCxZQUFZLE1BQWM7UUFDdEIsSUFBSSxDQUFDLEdBQUcsR0FBRyxJQUFJLHdDQUFjLENBQUMsTUFBTSxDQUFDLENBQUE7SUFDekMsQ0FBQztDQUlKO0FBWkQsa0NBWUMifQ==
|
|
5
dist/projectinfo.plugins.d.ts
vendored
5
dist/projectinfo.plugins.d.ts
vendored
@ -1,5 +0,0 @@
|
|||||||
import 'typings-global';
|
|
||||||
export declare let path: any;
|
|
||||||
export declare let Q: any;
|
|
||||||
export import smartfile = require('smartfile');
|
|
||||||
export import smartstring = require('smartstring');
|
|
7
dist/projectinfo.plugins.js
vendored
7
dist/projectinfo.plugins.js
vendored
@ -1,7 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-global");
|
|
||||||
exports.path = require('path');
|
|
||||||
exports.Q = require('q');
|
|
||||||
exports.smartfile = require("smartfile");
|
|
||||||
exports.smartstring = require("smartstring");
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8ucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Byb2plY3RpbmZvLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUNaLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUN0QixRQUFBLENBQUMsR0FBSSxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUE7QUFDNUIseUNBQThDO0FBQzlDLDZDQUFrRCJ9
|
|
@ -1,11 +1,17 @@
|
|||||||
{
|
{
|
||||||
"npmts": {
|
|
||||||
"mode": "default",
|
|
||||||
"coverageTreshold": 80
|
|
||||||
},
|
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"globalNpmTools": [
|
"npmGlobalTools": [],
|
||||||
"npmts"
|
"npmAccessLevel": "public"
|
||||||
]
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
|
"module": {
|
||||||
|
"githost": "gitlab.com",
|
||||||
|
"gitscope": "push.rocks",
|
||||||
|
"gitrepo": "projectinfo",
|
||||||
|
"description": "gather information about projects. supports npm, git etc.",
|
||||||
|
"npmPackagename": "@push.rocks/projectinfo",
|
||||||
|
"license": "MIT"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
47
package.json
47
package.json
@ -1,11 +1,15 @@
|
|||||||
{
|
{
|
||||||
"name": "projectinfo",
|
"name": "@push.rocks/projectinfo",
|
||||||
"version": "2.0.0",
|
"version": "5.0.2",
|
||||||
|
"private": false,
|
||||||
"description": "gather information about projects. supports npm, git etc.",
|
"description": "gather information about projects. supports npm, git etc.",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)"
|
"test": "(tstest test/)",
|
||||||
|
"build": "(tsbuild --web --allowimplicitany)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -25,14 +29,31 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/projectinfo#readme",
|
"homepage": "https://gitlab.com/pushrocks/projectinfo#readme",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"npmts-g": "^5.2.10",
|
"@gitzone/tsbuild": "^2.1.66",
|
||||||
"should": "^11.1.1",
|
"@gitzone/tsrun": "^1.2.44",
|
||||||
"typings-test": "^1.0.3"
|
"@gitzone/tstest": "^1.0.77",
|
||||||
|
"@push.rocks/tapbundle": "^5.0.12",
|
||||||
|
"@types/node": "^20.4.8"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"q": "^1.4.1",
|
"@push.rocks/smartfile": "^10.0.28",
|
||||||
"smartfile": "4.1.0",
|
"@push.rocks/smartpath": "^5.0.11",
|
||||||
"smartstring": "2.0.22",
|
"@push.rocks/smartpromise": "^4.0.3",
|
||||||
"typings-global": "^1.0.14"
|
"@push.rocks/smartstring": "^4.0.2"
|
||||||
}
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
4804
pnpm-lock.yaml
generated
Normal file
4804
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
49
readme.md
Normal file
49
readme.md
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
# @push.rocks/projectinfo
|
||||||
|
gather information about projects. supports npm, git etc.
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/projectinfo)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/push.rocks/projectinfo)
|
||||||
|
* [github.com (source mirror)](https://github.com/push.rocks/projectinfo)
|
||||||
|
* [docs (typedoc)](https://push.rocks.gitlab.io/projectinfo/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
|
||||||
|
Status Category | Status Badge
|
||||||
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { ProjectInfo } from 'projectinfo';
|
||||||
|
|
||||||
|
let myProjectInfo = new ProjectInfo('/some/path/to/proejct');
|
||||||
|
let npmName = myProjectInfo.npm.name; // returns npm name from package.json
|
||||||
|
let npmVersion = myProjectInfo.npm.version; // returns version from package.json
|
||||||
|
let gitRepo = myProjectInfo.git.gitrepo; // returns the name of the gitrepo
|
||||||
|
let gitRemotes = myProjectInfo.git.remotes; // returns array with registered remotes
|
||||||
|
|
||||||
|
// for more info check out the module in your IDE with TypeScript intellisense enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
|
## Legal
|
||||||
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
@ -2,6 +2,7 @@
|
|||||||
"name": "testpackage",
|
"name": "testpackage",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"description": "some test",
|
"description": "some test",
|
||||||
|
"type": "module",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/someuser/somerepo.git"
|
"url": "git+https://github.com/someuser/somerepo.git"
|
||||||
|
1
test/test.d.ts
vendored
1
test/test.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
import 'typings-test';
|
|
33
test/test.js
33
test/test.js
@ -1,33 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-test");
|
|
||||||
const projectinfo = require("../dist/index");
|
|
||||||
let should = require('should');
|
|
||||||
let path = require('path');
|
|
||||||
let testBasePath = path.resolve(__dirname);
|
|
||||||
describe('projectinfo', function () {
|
|
||||||
describe('.npm() return', function () {
|
|
||||||
let myNpm = new projectinfo.ProjectinfoNpm(testBasePath, { gitAccessToken: 'sometoken' });
|
|
||||||
it('should have .packageJson', function () {
|
|
||||||
should(myNpm.packageJson).have.property('version', '1.0.0');
|
|
||||||
should(myNpm.packageJson).have.property('name', 'testpackage');
|
|
||||||
});
|
|
||||||
it('should have .version', function () {
|
|
||||||
should(myNpm).have.property('version', '1.0.0');
|
|
||||||
});
|
|
||||||
it('should have .name', function () {
|
|
||||||
should(myNpm).have.property('name', 'testpackage');
|
|
||||||
});
|
|
||||||
it('should have .license', function () {
|
|
||||||
should(myNpm).have.property('license', 'MIT');
|
|
||||||
});
|
|
||||||
it('should have .git', function () {
|
|
||||||
should(myNpm.git.httpsUrl).equal('https://sometoken@github.com/someuser/somerepo.git');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
describe('.getNpmNameForDir()', function () {
|
|
||||||
it('should return a name', function () {
|
|
||||||
should(projectinfo.getNpmNameForDir(testBasePath)).equal('testpackage');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQiw2Q0FBNkM7QUFDN0MsSUFBSSxNQUFNLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFBO0FBQzlCLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUMxQixJQUFJLFlBQVksR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0FBRTFDLFFBQVEsQ0FBQyxhQUFhLEVBQUM7SUFDbkIsUUFBUSxDQUFDLGVBQWUsRUFBQztRQUNyQixJQUFJLEtBQUssR0FBRyxJQUFJLFdBQVcsQ0FBQyxjQUFjLENBQUMsWUFBWSxFQUFDLEVBQUMsY0FBYyxFQUFFLFdBQVcsRUFBQyxDQUFDLENBQUE7UUFDdEYsRUFBRSxDQUFDLDBCQUEwQixFQUFDO1lBQzFCLE1BQU0sQ0FBQyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxTQUFTLEVBQUMsT0FBTyxDQUFDLENBQUE7WUFDMUQsTUFBTSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sRUFBQyxhQUFhLENBQUMsQ0FBQTtRQUNqRSxDQUFDLENBQUMsQ0FBQTtRQUVGLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQztZQUN0QixNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxTQUFTLEVBQUMsT0FBTyxDQUFDLENBQUE7UUFDbEQsQ0FBQyxDQUFDLENBQUE7UUFFRixFQUFFLENBQUMsbUJBQW1CLEVBQUM7WUFDbkIsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFDLGFBQWEsQ0FBQyxDQUFBO1FBQ3JELENBQUMsQ0FBQyxDQUFBO1FBRUYsRUFBRSxDQUFDLHNCQUFzQixFQUFDO1lBQ3RCLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLFNBQVMsRUFBQyxLQUFLLENBQUMsQ0FBQTtRQUNoRCxDQUFDLENBQUMsQ0FBQTtRQUNGLEVBQUUsQ0FBQyxrQkFBa0IsRUFBQztZQUNsQixNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQyxLQUFLLENBQUMsb0RBQW9ELENBQUMsQ0FBQTtRQUMxRixDQUFDLENBQUMsQ0FBQTtJQUVOLENBQUMsQ0FBQyxDQUFBO0lBRUYsUUFBUSxDQUFDLHFCQUFxQixFQUFDO1FBQzNCLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQztZQUN0QixNQUFNLENBQUMsV0FBVyxDQUFDLGdCQUFnQixDQUFDLFlBQVksQ0FBQyxDQUM1QyxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsQ0FBQTtRQUM5QixDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==
|
|
@ -1 +0,0 @@
|
|||||||
{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,WAAW,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC9C,IAAI,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC/B,IAAI,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC3B,IAAI,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAE3C,QAAQ,CAAC,aAAa,EAAC;IACnB,QAAQ,CAAC,eAAe,EAAC;QACrB,IAAI,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,YAAY,EAAC,EAAC,cAAc,EAAC,WAAW,EAAC,CAAC,CAAC;QACvE,EAAE,CAAC,0BAA0B,EAAC;YAC1B,KAAK,CAAC,WAAW;iBACb,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAC,OAAO,CAAC,CAAC;YAC5C,KAAK,CAAC,WAAW;iBACb,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,aAAa,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAC;YACtB,KAAK;iBACA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAC,OAAO,CAAC,CAAA;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAC;YACnB,KAAK;iBACA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,aAAa,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAC;YACtB,KAAK;iBACA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAC,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kBAAkB,EAAC;YAClB,KAAK,CAAC,GAAG,CAAC,QAAQ;iBACb,MAAM,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IAEP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAC;QAClB,EAAE,CAAC,sBAAsB,EAAC;YACtB,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC;iBAC5B,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAC"}
|
|
58
test/test.ts
58
test/test.ts
@ -1,38 +1,32 @@
|
|||||||
import 'typings-test'
|
import { tap, expect } from '@push.rocks/tapbundle';
|
||||||
import projectinfo = require('../dist/index')
|
import * as smartpath from '@push.rocks/smartpath';
|
||||||
let should = require('should')
|
import * as projectinfo from '../ts/index.js';
|
||||||
let path = require('path')
|
|
||||||
let testBasePath = path.resolve(__dirname)
|
|
||||||
|
|
||||||
describe('projectinfo',function(){
|
import * as path from 'path';
|
||||||
describe('.npm() return',function(){
|
let testBasePath = path.resolve(smartpath.get.dirnameFromImportMetaUrl(import.meta.url));
|
||||||
let myNpm = new projectinfo.ProjectinfoNpm(testBasePath,{gitAccessToken: 'sometoken'})
|
|
||||||
it('should have .packageJson',function(){
|
|
||||||
should(myNpm.packageJson).have.property('version','1.0.0')
|
|
||||||
should(myNpm.packageJson).have.property('name','testpackage')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should have .version',function(){
|
let myNpm = new projectinfo.ProjectinfoNpm(testBasePath, { gitAccessToken: 'sometoken' });
|
||||||
should(myNpm).have.property('version','1.0.0')
|
tap.test('should have .packageJson', async () => {
|
||||||
})
|
expect(myNpm.packageJson).property('version').toEqual('1.0.0');
|
||||||
|
expect(myNpm.packageJson).property('name').toEqual('testpackage');
|
||||||
|
});
|
||||||
|
|
||||||
it('should have .name',function(){
|
tap.test('should have .version', async () => {
|
||||||
should(myNpm).have.property('name','testpackage')
|
expect(myNpm).property('version').toEqual('1.0.0');
|
||||||
})
|
});
|
||||||
|
|
||||||
it('should have .license',function(){
|
tap.test('should have .name', async () => {
|
||||||
should(myNpm).have.property('license','MIT')
|
expect(myNpm).property('name').toEqual('testpackage');
|
||||||
})
|
});
|
||||||
it('should have .git',function(){
|
|
||||||
should(myNpm.git.httpsUrl).equal('https://sometoken@github.com/someuser/somerepo.git')
|
|
||||||
})
|
|
||||||
|
|
||||||
})
|
tap.test('should have .license', async () => {
|
||||||
|
expect(myNpm).property('license').toEqual('MIT');
|
||||||
|
});
|
||||||
|
tap.test('should have .git', async () => {
|
||||||
|
expect(myNpm.git.httpsUrl).toEqual('https://sometoken@github.com/someuser/somerepo.git');
|
||||||
|
});
|
||||||
|
tap.test('should return a name', async () => {
|
||||||
|
expect(projectinfo.getNpmNameForDir(testBasePath)).toEqual('testpackage');
|
||||||
|
});
|
||||||
|
|
||||||
describe('.getNpmNameForDir()',function(){
|
tap.start();
|
||||||
it('should return a name',function(){
|
|
||||||
should(projectinfo.getNpmNameForDir(testBasePath)
|
|
||||||
).equal('testpackage')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/projectinfo',
|
||||||
|
version: '5.0.2',
|
||||||
|
description: 'gather information about projects. supports npm, git etc.'
|
||||||
|
}
|
27
ts/index.ts
27
ts/index.ts
@ -1,32 +1,21 @@
|
|||||||
import 'typings-global'
|
import * as plugins from './projectinfo.plugins.js';
|
||||||
import plugins = require('./projectinfo.plugins')
|
|
||||||
|
|
||||||
// direct access to classes
|
// direct access to classes
|
||||||
export * from './projectinfo.classes.git'
|
export * from './projectinfo.classes.git.js';
|
||||||
export * from './projectinfo.classes.npm'
|
export * from './projectinfo.classes.npm.js';
|
||||||
export * from './projectinfo.classes.projectinfo'
|
export * from './projectinfo.classes.projectinfo.js';
|
||||||
|
|
||||||
// npm
|
// npm
|
||||||
import { ProjectinfoNpm } from './projectinfo.classes.npm'
|
import { ProjectinfoNpm } from './projectinfo.classes.npm.js';
|
||||||
|
|
||||||
// quick functions
|
// quick functions
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gets the name from package.json in a specified directory
|
* gets the name from package.json in a specified directory
|
||||||
*/
|
*/
|
||||||
export let getNpmNameForDir = function(cwdArg){
|
export let getNpmNameForDir = function (cwdArg) {
|
||||||
let localNpm = new ProjectinfoNpm(cwdArg)
|
let localNpm = new ProjectinfoNpm(cwdArg);
|
||||||
if (localNpm.status === 'ok') {
|
if (localNpm.status === 'ok') {
|
||||||
return localNpm.name
|
return localNpm.name;
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/* TODO
|
|
||||||
projectinfo.git = function(){
|
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
projectinfo.mojo = function(){
|
|
||||||
|
|
||||||
};
|
|
||||||
*/
|
|
||||||
|
@ -1,8 +1,29 @@
|
|||||||
import 'typings-global'
|
import * as plugins from './projectinfo.plugins.js';
|
||||||
|
|
||||||
export class ProjectinfoGit {
|
export class ProjectinfoGit {
|
||||||
isGit: boolean
|
isGit: boolean;
|
||||||
constructor() {
|
githost: string;
|
||||||
|
gituser: string;
|
||||||
|
gitrepo: string;
|
||||||
|
cwd: string;
|
||||||
|
constructor(cwdArg: string) {
|
||||||
|
this.cwd = cwdArg;
|
||||||
|
this.getGitInfoFromPath();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get git info from path
|
||||||
|
*/
|
||||||
|
getGitInfoFromPath() {
|
||||||
|
let localSmartpath = new plugins.smartpath.Smartpath(this.cwd);
|
||||||
|
this.gitrepo = localSmartpath.pathLevelsBackwards[0];
|
||||||
|
this.gituser = localSmartpath.pathLevelsBackwards[1];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get git info from remote url
|
||||||
|
*/
|
||||||
|
getGitInfoFromRemote(remoteUrlArg: string) {
|
||||||
|
let gitRepoParsed = new plugins.smartstring.GitRepo(remoteUrlArg);
|
||||||
}
|
}
|
||||||
}
|
}
|
@ -1,32 +1,32 @@
|
|||||||
import 'typings-global'
|
import * as plugins from './projectinfo.plugins.js';
|
||||||
import plugins = require('./projectinfo.plugins')
|
|
||||||
export class ProjectinfoNpm {
|
export class ProjectinfoNpm {
|
||||||
isNpm: boolean = false
|
isNpm: boolean = false;
|
||||||
packageJson: any
|
packageJson: any;
|
||||||
name: string
|
name: string;
|
||||||
version: string
|
version: string;
|
||||||
status: string
|
status: string;
|
||||||
license: string
|
license: string;
|
||||||
git
|
git: plugins.smartstring.GitRepo;
|
||||||
|
|
||||||
constructor(cwdArg: string, optionsArg: { gitAccessToken?: string } = {}) {
|
constructor(cwdArg: string, optionsArg: { gitAccessToken?: string } = {}) {
|
||||||
let resolvedCwd = plugins.path.resolve(cwdArg)
|
let resolvedCwd = plugins.path.resolve(cwdArg);
|
||||||
if (plugins.smartfile.fs.fileExists(plugins.path.join(resolvedCwd, 'package.json'))) {
|
if (plugins.smartfile.fs.fileExists(plugins.path.join(resolvedCwd, 'package.json'))) {
|
||||||
this.isNpm = true
|
this.isNpm = true;
|
||||||
this.packageJson = plugins.smartfile.fs.toObjectSync(
|
this.packageJson = plugins.smartfile.fs.toObjectSync(
|
||||||
plugins.path.join(
|
plugins.path.join(resolvedCwd, 'package.json'),
|
||||||
resolvedCwd,
|
|
||||||
'package.json'
|
|
||||||
),
|
|
||||||
'json'
|
'json'
|
||||||
)
|
);
|
||||||
this.name = this.packageJson.name
|
this.name = this.packageJson.name;
|
||||||
this.version = this.packageJson.version
|
this.version = this.packageJson.version;
|
||||||
this.status = 'ok'
|
this.status = 'ok';
|
||||||
this.license = this.packageJson.license
|
this.license = this.packageJson.license;
|
||||||
if (this.packageJson.repository) {
|
if (this.packageJson.repository) {
|
||||||
this.git = new plugins.smartstring.GitRepo(this.packageJson.repository.url, optionsArg.gitAccessToken)
|
this.git = new plugins.smartstring.GitRepo(
|
||||||
};
|
this.packageJson.repository.url,
|
||||||
|
optionsArg.gitAccessToken
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
import * as plugins from './projectinfo.plugins'
|
import * as plugins from './projectinfo.plugins.js';
|
||||||
import { ProjectinfoNpm } from './projectinfo.classes.npm'
|
import { ProjectinfoNpm } from './projectinfo.classes.npm.js';
|
||||||
|
import { ProjectinfoGit } from './projectinfo.classes.git.js';
|
||||||
export type TProjectType = 'git' | 'npm'
|
export type TProjectType = 'git' | 'npm';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class projectinfo automatically examines a given directory and exposes relevant info about it
|
* class projectinfo automatically examines a given directory and exposes relevant info about it
|
||||||
*/
|
*/
|
||||||
export class ProjectInfo {
|
export class ProjectInfo {
|
||||||
type: TProjectType
|
type: TProjectType;
|
||||||
npm: ProjectinfoNpm
|
npm: ProjectinfoNpm;
|
||||||
|
git: ProjectinfoGit;
|
||||||
/**
|
/**
|
||||||
* this constructor
|
* constructor of class ProjectInfo
|
||||||
*/
|
*/
|
||||||
constructor(cwdArg: string) {
|
constructor(cwdArg: string) {
|
||||||
this.npm = new ProjectinfoNpm(cwdArg)
|
this.npm = new ProjectinfoNpm(cwdArg);
|
||||||
|
this.git = new ProjectinfoGit(cwdArg);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
@ -1,5 +1,7 @@
|
|||||||
import 'typings-global'
|
import * as path from 'path';
|
||||||
export let path = require('path')
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
export let Q = require('q')
|
import * as smartfile from '@push.rocks/smartfile';
|
||||||
export import smartfile = require('smartfile')
|
import * as smartstring from '@push.rocks/smartstring';
|
||||||
export import smartstring = require('smartstring')
|
import * as smartpath from '@push.rocks/smartpath';
|
||||||
|
|
||||||
|
export { path, smartpromise, smartfile, smartstring, smartpath };
|
||||||
|
9
tsconfig.json
Normal file
9
tsconfig.json
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "ES2022",
|
||||||
|
"moduleResolution": "nodenext"
|
||||||
|
}
|
||||||
|
}
|
@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "tslint-config-standard"
|
|
||||||
}
|
|
Reference in New Issue
Block a user