initial-commit

This commit is contained in:
nicwands
2026-03-24 13:52:38 -04:00
commit a94aea110a
14 changed files with 343 additions and 0 deletions

38
template/.gitignore vendored Normal file
View File

@@ -0,0 +1,38 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
.env
node_modules
.DS_Store
dist
dist-ssr
coverage
*.local
.npmrc
# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
*.tsbuildinfo
.eslintcache
# Cypress
/cypress/videos/
/cypress/screenshots/
# Vitest
__screenshots__/

1
template/.nvmrc Normal file
View File

@@ -0,0 +1 @@
22

20
template/README.md Normal file
View File

@@ -0,0 +1,20 @@
# Taker of Notes Plugin: ${NAME_TITLE_CASE}
${DESCRIPTION}
## Getting Started
1. Install dependencies: `npm install`
2. Run tests: `npm test`
3. Build: `npm run build`
## Project Structure
- `src/` - Source code
- `test/` - Tests
- `dist/` - Built output
- `rollup.config.js` - Build configuration
## Development
Implement your storage adapter in `src/${NAME_PASCAL_CASE}.js`.

27
template/package.json Normal file
View File

@@ -0,0 +1,27 @@
{
"name": "@takerofnotes/plugin-${NAME_KEBAB_CASE}",
"version": "0.1.0",
"repository": {
"type": "git"
},
"type": "module",
"main": "dist/index.js",
"exports": "./dist/index.js",
"scripts": {
"build": "rollup -c",
"test": "vitest",
"prepublishOnly": "npm run build"
},
"author": "nicwands",
"license": "MIT",
"description": "${DESCRIPTION}",
"dependencies": {
"@takerofnotes/plugin-sdk": "^0.2.0"
},
"devDependencies": {
"@rollup/plugin-commonjs": "^29.0.0",
"@rollup/plugin-node-resolve": "^16.0.3",
"rollup": "^4.59.0",
"vitest": "^4.0.18"
}
}

13
template/rollup.config.js Normal file
View File

@@ -0,0 +1,13 @@
// rollup.config.js
import resolve from '@rollup/plugin-node-resolve'
import commonjs from '@rollup/plugin-commonjs'
export default {
input: 'src/index.js',
output: {
file: 'dist/index.js',
format: 'esm',
sourcemap: true,
},
plugins: [resolve(), commonjs()],
}

View File

@@ -0,0 +1,23 @@
import { BaseNotesAdapter } from '@takerofnotes/plugin-sdk'
export default class ${NAME_PASCAL_CASE}Adapter extends BaseNotesAdapter {
constructor(config) {
super()
for (const field in config) {
this[field] = config[field]
}
}
async init() {}
async getAll() {}
async create(note) {}
async update(note) {}
async delete(id) {}
async testConnection() {}
}

14
template/src/index.js Normal file
View File

@@ -0,0 +1,14 @@
import { definePlugin } from '@takerofnotes/plugin-sdk'
import ${NAME_PASCAL_CASE}Adapter from './${NAME_PASCAL_CASE}Adapter'
export default definePlugin({
id: '${NAME_KEBAB_CASE}',
name: '${NAME_TITLE_CASE}',
description: '${DESCRIPTION}',
version: '0.1.0',
apiVersion: '0.3.1',
configSchema: [],
createAdapter(config) {
return new ${NAME_PASCAL_CASE}Adapter(config)
},
})

View File

@@ -0,0 +1,8 @@
import { describePluginTests } from '@takerofnotes/plugin-sdk'
import plugin from '../src/index.js'
const adapter = plugin.createAdapter({
// Adapter config here
})
describePluginTests({ plugin, adapter }, describe, it, expect)

View File

@@ -0,0 +1,8 @@
import { defineConfig } from 'vitest/config'
export default defineConfig({
test: {
globals: true,
testTimeout: 30000,
},
})