update tsconfig
This commit is contained in:
parent
ec8bf16979
commit
ba5474f2f2
|
|
@ -5,17 +5,27 @@
|
|||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartrestic",
|
||||
"description": "a modules packaging restic",
|
||||
"description": "A module that packages restic for easy use and integration in Node.js projects.",
|
||||
"npmPackagename": "@push.rocks/smartrestic",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"restic",
|
||||
"backup",
|
||||
"node.js",
|
||||
"typescript",
|
||||
"data management",
|
||||
"archive",
|
||||
"security",
|
||||
"data protection"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdocs": {
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
61
package.json
Normal file
61
package.json
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
{
|
||||
"name": "@push.rocks/smartrestic",
|
||||
"version": "0.16.2",
|
||||
"private": false,
|
||||
"description": "A module that packages restic for easy use and integration in Node.js projects.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Task Venture Capital GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "(tsdoc)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.25",
|
||||
"@git.zone/tsbundle": "^2.0.5",
|
||||
"@git.zone/tsrun": "^1.2.46",
|
||||
"@git.zone/tstest": "^1.0.44",
|
||||
"@push.rocks/tapbundle": "^5.0.15",
|
||||
"@types/node": "^20.8.7"
|
||||
},
|
||||
"dependencies": {
|
||||
"@push.rocks/smartarchive": "^4.0.19",
|
||||
"@push.rocks/smartrequest": "^2.0.21"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://gitlab.com/push.rocks/smartrestic.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/push.rocks/smartrestic/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/push.rocks/smartrestic#readme",
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
],
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"keywords": [
|
||||
"restic",
|
||||
"backup",
|
||||
"node.js",
|
||||
"typescript",
|
||||
"data management",
|
||||
"archive",
|
||||
"security",
|
||||
"data protection"
|
||||
]
|
||||
}
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
|
||||
65
readme.md
Normal file
65
readme.md
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
# @push.rocks/smartrestic
|
||||
a modules packaging restic
|
||||
|
||||
## Install
|
||||
To install `@push.rocks/smartrestic`, you need to have Node.js installed on your system. Once you have Node.js and npm (Node.js package manager) set up, installing `@push.rocks/smartrestic` is straightforward. Simply open your terminal (Command Prompt, PowerShell, or any Linux/Mac terminal), and run the following command:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartrestic --save
|
||||
```
|
||||
|
||||
This command will download `@push.rocks/smartrestic` and its dependencies, making it available for use within your project.
|
||||
|
||||
## Usage
|
||||
`@push.rocks/smartrestic` is a module designed to enhance the interaction with restic, a modern backup program that can back up your files to various types of storage. This guide will walk you through the usage of `@push.rocks/smartrestic` providing code examples in TypeScript to ensure you can leverage its functionalities effectively.
|
||||
|
||||
### Setting Up
|
||||
Before diving into the examples, ensure you are set up to use TypeScript and have `@push.rocks/smartrestic` installed in your project. Create a new TypeScript file (e.g., `ExampleUsage.ts`) and import the necessary modules as shown below:
|
||||
|
||||
```typescript
|
||||
import * as smartrestic from '@push.rocks/smartrestic';
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
Let's start with a basic example to demonstrate initializing and using the smartrestic module. The following snippet illustrates how to use the provided `demoExport` for a simple logging operation:
|
||||
|
||||
```typescript
|
||||
import { demoExport } from '@push.rocks/smartrestic';
|
||||
|
||||
// Log the exported string to the console
|
||||
console.log(demoExport); // Should output: "Hi there! :) This is an exported string"
|
||||
```
|
||||
|
||||
### Advanced Features
|
||||
While the sample code provided offers a glimpse into utilizing `@push.rocks/smartrestic`, it is important to explore the module's advanced features for effective integration with restic. As of the current version, the module primarily serves as a scaffold for packaging restic-related functionalities.
|
||||
|
||||
To utilize restic efficiently within your Node.js projects, consider directly interacting with restic's command-line interface (CLI) through child processes in Node.js or leveraging additional modules that provide a higher abstraction level for restic operations. Keep an eye on the module's repository for updates and new feature releases.
|
||||
|
||||
**Note:** Since the package contents provided do not include direct restic functionality examples beyond a simple export, further details on advanced usage with restic are beyond the current scope and would be speculative.
|
||||
|
||||
### Contributing and Issues
|
||||
If you encounter issues with `@push.rocks/smartrestic` or have suggestions for improvements, consider contributing to the project's repository on GitLab. Contributions, issue reports, and feature requests are welcomed to enhance the module.
|
||||
|
||||
To report an issue or contribute, visit the project's issues page on [GitLab](https://gitlab.com/push.rocks/smartrestic/issues).
|
||||
|
||||
### Conclusion
|
||||
`@push.rocks/smartrestic` provides a packaging around restic, aiming to streamline the backup process in your Node.js applications. While the current functionality is foundational, the project is open to contributions and enhancements. By integrating `@push.rocks/smartrestic` into your development workflow, you pave the way for more robust and scalable backup solutions employing restic's powerful features. Keep an eye on the project's repository for future updates and additional functionalities.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
Loading…
Reference in New Issue
Block a user