Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add config options, formatting updates, update packages #17

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
f977ddf
Add feature to filter to specific schema
Hankanman Sep 11, 2024
77a791d
Support running with npx
Hankanman Sep 11, 2024
b1ebbca
Repoint to new repo source
Hankanman Sep 11, 2024
da06315
Add ability to filter to include/exclude tables and types
Hankanman Sep 11, 2024
abac175
Added ability to export in pureMarkdown for LLM context minimising to…
Hankanman Sep 11, 2024
7038864
Promote to v2.0.1
Hankanman Sep 11, 2024
cef65dc
Bump to v2.0.1 add features: print table of contents, print RLS Policies
Hankanman Sep 12, 2024
9d21ebb
Update to version 2.0.3; enhance configuration options, add support f…
Hankanman Dec 30, 2024
6a5cc5d
Update to version 2.0.3; add dotenv support for environment variables…
Hankanman Jan 3, 2025
6f12434
Upgrade to version 3.0.0; introduce .env.template for database connec…
Hankanman Jan 3, 2025
d2fb9a0
Update repolint workflow to use new repository source for custom rules
Hankanman Jan 3, 2025
8e93723
Update Changelog
Hankanman Jan 3, 2025
79d6195
Enhance CI workflow by adding Docker Buildx and Docker Compose setup …
Hankanman Jan 3, 2025
c6499c8
Update Node.js version in CI workflow from 12 to 16 for improved comp…
Hankanman Jan 3, 2025
9996f6c
Refactor README.md for clarity and organization; update usage instruc…
Hankanman Jan 3, 2025
0baf1a0
Upgrade version to 3.0.1 in package.json and package-lock.json for @h…
Hankanman Jan 3, 2025
67e8e92
Refactor project to align with Klarna branding: update repository URL…
Hankanman Jan 3, 2025
d2d7c15
Update package name in README from @hankanman/postgres-to-docs to @kl…
Hankanman Jan 3, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Refactor project to align with Klarna branding: update repository URL…
…s, package name, and contact information. Enhance README with new badges and improve TypeScript configuration. Update CHANGELOG for clarity.
Hankanman committed Jan 3, 2025
commit 67e8e9257f7680bf8e49dd7c8e5c929ee4395b42
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
developers@hankanman.com.
developers@klarna.com.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ All members of our community are expected to follow our [Code of Conduct](CODE_O
## Get in touch

- Report bugs, suggest features or view the source code on GitHub.
- If you have any questions concerning this product, please contact developers@hankanman.com.
- If you have any questions concerning this product, please contact developers@klarna.com.

## Contributing to development

6 changes: 3 additions & 3 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@
Klarna takes security seriously and wants to ensure that we maintain a secure environment for our customers and that we also provide secure solutions for the open source community. To help us achieve these goals, please note the following before using this software:

- Review the software license to understand Klarna's obligations in terms of warranties and suitability for purpose
- For any questions or concerns about security, you can reach out directly to Klarna's security team at security@hankanman.com
- For any questions or concerns about security, you can reach out directly to Klarna's security team at security@klarna.com
- We request that you work with our security team and opt for [responsible disclosure](https://corporate.walmart.com/article/responsible-disclosure-policy) using the guidelines below
- We enforce SLAs on our security team and software engineers to remediate security bugs in a timely manner
- All security related issues and pull requests you make should be tagged with "security" for easy identification
@@ -15,7 +15,7 @@ Klarna takes security seriously and wants to ensure that we maintain a secure en

If you find a security bug in this repository, please work with Klarna's security team following responsible disclosure principles and these guidelines:

- Do not submit a normal issue or pull request in our public repository, instead report directly to security@hankanman.com (If you would like to encrypt, please contact us for keys)
- Do not submit a normal issue or pull request in our public repository, instead report directly to security@klarna.com (If you would like to encrypt, please contact us for keys)
- We will review your submission and may follow up for additional details
- If you have a patch, we will review it and approve it privately; once approved for release you can submit it as a pull request publicly in our repos (we give credit where credit is due)
- We will keep you informed during our investigation, feel free to check in for a status update
@@ -24,4 +24,4 @@ If you find a security bug in this repository, please work with Klarna's securit

## Contact / Misc.

If you have any questions, please reach out directly to the Klarna Security team at security@hankanman.com
If you have any questions, please reach out directly to the Klarna Security team at security@klarna.com
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -43,5 +43,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Initial release

<!-- Markdown link dfn's -->
[unreleased]: https://github.com/Hankanman/postgres-to-docs/compare/v0.1.1...HEAD
[0.1.1]: https://github.com/Hankanman/postgres-to-docs/releases/tag/v0.1.1
[unreleased]: https://github.com/klarna-incubator/postgres-to-docs/compare/v0.1.1...HEAD
[0.1.1]: https://github.com/klarna-incubator/postgres-to-docs/releases/tag/v0.1.1
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Postgres to Docs
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hankanman/postgres-to-docs/repolint.yml)
![NPM Downloads](https://img.shields.io/npm/d18m/%40hankanman%2Fpostgres-to-docs)
![GitHub License](https://img.shields.io/github/license/hankanman/postgres-to-docs)
![NPM Version](https://img.shields.io/npm/v/%40hankanman%2Fpostgres-to-docs)
[![Build Status][ci-image]][ci-url]
[![License][license-image]][license-url]
[![Developed at Klarna][klarna-image]][klarna-url]

Make your database documentation smooth by generating markdown for your schema. You need to get a quick and easy overview of your database schema but don't want to...
* Open the source code and find the model definitions
@@ -151,7 +150,15 @@ See our [changelog](CHANGELOG.md).

Copyright © 2021 Klarna Bank AB

For license details, see the [LICENSE](LICENSE) file in the root of this project.

Contributors:
- [@hankanman](https://github.com/hankanman)

For license details, see the [LICENSE](LICENSE) file in the root of this project.
<!-- Markdown link & img dfn's -->
[ci-image]: https://img.shields.io/badge/build-passing-brightgreen?style=flat-square
[ci-url]: https://github.com/klarna-incubator/TODO
[license-image]: https://img.shields.io/badge/license-Apache%202-blue?style=flat-square
[license-url]: http://www.apache.org/licenses/LICENSE-2.0
[klarna-image]: https://img.shields.io/badge/%20-Developed%20at%20Klarna-black?labelColor=ffb3c7&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAOCAYAAAAmL5yKAAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAALQAAAAAQAAAtAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABCgAwAEAAAAAQAAAA4AAAAA0LMKiwAAAAlwSFlzAABuugAAbroB1t6xFwAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAVBJREFUKBVtkz0vREEUhsdXgo5qJXohkUgQ0fgFNFpR2V5ClP6CQu9PiB6lEL1I7B9A4/treZ47c252s97k2ffMmZkz5869m1JKL/AFbzAHaiRbmsIf4BdaMAZqMFsOXNxXkroKbxCPV5l8yHOJLVipn9/vEreLa7FguSN3S2ynA/ATeQuI8tTY6OOY34DQaQnq9mPCDtxoBwuRxPfAvPMWnARlB12KAi6eLTPruOOP4gcl33O6+Sjgc83DJkRH+h2MgorLzaPy68W48BG2S+xYnmAa1L+nOxEduMH3fgjGFvZeVkANZau68B6CrgJxWosFFpF7iG+h5wKZqwt42qIJtARu/ix+gqsosEq8D35o6R3c7OL4lAnTDljEe9B3Qa2BYzmHemDCt6Diwo6JY7E+A82OnN9HuoBruAQvUQ1nSxP4GVzBDRyBfygf6RW2/gD3NmEv+K/DZgAAAABJRU5ErkJggg==
[klarna-url]: https://github.com/klarna-incubator
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@hankanman/postgres-to-docs",
"name": "@klarna/postgres-to-docs",
"version": "3.0.1",
"description": "The smooth way to document your Postgres database",
"main": "./dist/index.js",
@@ -14,14 +14,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hankanman/postgres-to-docs.git"
"url": "git+https://github.com/klarna-incubator/postgres-to-docs.git"
},
"author": "",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/Hankanman/postgres-to-docs/issues"
"url": "https://github.com/klarna-incubator/postgres-to-docs/issues"
},
"homepage": "https://github.com/Hankanman/postgres-to-docs#readme",
"homepage": "https://github.com/klarna-incubator/postgres-to-docs#readme",
"dependencies": {
"dotenv": "^16.3.1",
"elm-decoders": "^6.0.1",
21 changes: 11 additions & 10 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
{
"compilerOptions": {
"target": "es2018",
"module": "commonjs",
"lib": ["es2018"],
"strict": true,
"allowJs": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"outDir": "./dist",
"rootDir": "./src",
"module": "commonjs",
"moduleResolution": "node",
"target": "es2019",
"outDir": "dist",
"sourceMap": true,
"strict": true,
"resolveJsonModule": true
},
"include": ["src/**/*"],
"exclude": ["node_modules", "**/*.test.ts"]
}
"include": [
"src/**/*.ts"
],
}