Skip to content

Commit

Permalink
chore: initialise repository
Browse files Browse the repository at this point in the history
  • Loading branch information
amandesai01 committed Jul 25, 2024
0 parents commit f48f73e
Show file tree
Hide file tree
Showing 7 changed files with 4,426 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
node_modules
coverage
dist
.vscode
.DS_Store
.eslintcache
*.log*
*.env*
21 changes: 21 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
94 changes: 94 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# @profilecity/unstorage-s3-driver

<!-- automd:badges color=yellow -->

[![npm version](https://img.shields.io/npm/v/@profilecity/unstorage-s3-driver?color=yellow)](https://npmjs.com/package/@profilecity/unstorage-s3-driver)
[![npm downloads](https://img.shields.io/npm/dm/@profilecity/unstorage-s3-driver?color=yellow)](https://npmjs.com/package/@profilecity/unstorage-s3-driver)

<!-- /automd -->

This is my package description.

## Usage

Install package:

<!-- automd:pm-install -->

```sh
# ✨ Auto-detect
npx nypm install @profilecity/unstorage-s3-driver

# npm
npm install @profilecity/unstorage-s3-driver

# yarn
yarn add @profilecity/unstorage-s3-driver

# pnpm
pnpm install @profilecity/unstorage-s3-driver

# bun
bun install @profilecity/unstorage-s3-driver
```

<!-- /automd -->

Import:

<!-- automd:jsimport cjs cdn name="pkg" -->

**ESM** (Node.js, Bun)

```js
import {} from "pkg";
```

**CommonJS** (Legacy Node.js)

```js
const {} = require("pkg");
```

**CDN** (Deno, Bun and Browsers)

```js
import {} from "https://esm.sh/pkg";
```

<!-- /automd -->

## Development

<details>

<summary>local development</summary>

- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run interactive tests using `pnpm dev`

</details>

## License

<!-- automd:contributors license=MIT -->

Published under the [MIT](https://github.com/unjs/@profilecity/unstorage-s3-driver/blob/main/LICENSE) license.
Made by [community](https://github.com/unjs/@profilecity/unstorage-s3-driver/graphs/contributors) 💛
<br><br>
<a href="https://github.com/unjs/@profilecity/unstorage-s3-driver/graphs/contributors">
<img src="https://contrib.rocks/image?repo=unjs/@profilecity/unstorage-s3-driver" />
</a>

<!-- /automd -->

<!-- automd:with-automd -->

---

_🤖 auto updated with [automd](https://automd.unjs.io)_

<!-- /automd -->
19 changes: 19 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"$schema": "https://biomejs.dev/schemas/1.7.1/schema.json",
"formatter": {
"indentStyle": "space"
},
"files": {
"ignore": []
},
"javascript": {
"formatter": {
"arrowParentheses": "always"
}
},
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
}
}
3 changes: 3 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import unjs from "eslint-config-unjs";

export default unjs();
50 changes: 50 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"name": "@profilcity/unstorage-s3-driver",
"version": "0.0.0",
"description": "S3 Driver for Unstorage (by UnJS)",
"repository": "profilcity/unstorage-s3-driver",
"author": "Aman Desai <amandesai01@gmail.com>",
"license": "MIT",
"sideEffects": false,
"type": "module",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
}
},
"main": "./dist/index.cjs",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"files": [
"dist"
],
"scripts": {
"build": "unbuild",
"dev": "vitest dev",
"lint": "eslint . && biome check .",
"lint:fix": "automd && eslint . --fix && biome check --apply .",
"prepack": "yarn build",
"play": "jiti playground",
"release": "yarn test && changelogen --release && npm publish && git push --follow-tags",
"test": "yarn lint && yarn test:types && vitest run --coverage",
"test:types": "tsc --noEmit --skipLibCheck"
},
"devDependencies": {
"@biomejs/biome": "^1.7.2",
"@types/node": "^20.12.7",
"@vitest/coverage-v8": "^1.5.3",
"automd": "^0.3.7",
"changelogen": "^0.5.5",
"eslint": "^9.1.1",
"eslint-config-unjs": "^0.3.0-rc.7",
"jiti": "^1.21.0",
"typescript": "^5.4.5",
"unbuild": "^2.0.0",
"vitest": "^1.5.3"
},
"peerDependencies": {
"unstorage": "^1.10.2"
}
}
Loading

0 comments on commit f48f73e

Please sign in to comment.