Skip to content
This repository has been archived by the owner on Oct 9, 2024. It is now read-only.

Commit

Permalink
v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisCates committed Jul 24, 2022
0 parents commit 24ddf9b
Show file tree
Hide file tree
Showing 181 changed files with 12,727 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2.1

orbs:
node: circleci/[email protected]

workflows:
basic:
jobs:
- node/test:
version: '16.10'
pkg-manager: yarn
20 changes: 20 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
module.exports = {
env: {
browser: false,
es2021: true
},
extends: [
'standard'
],
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module'
},
plugins: [
'@typescript-eslint'
],
rules: {
'no-tabs': 0
}
}
127 changes: 127 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# Print
dist/test
home
Empty file added .gitkeep
Empty file.
5 changes: 5 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npm run lint
npm run test
4 changes: 4 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.circleci
.husky
example
test
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 🛠️ CHANGELOG

## v1.0.0

#### Official API starts with the spec

```bash
printer new [path]
printer component <path>
printer type <path>
printer inject <slice component>
printer slice <name>
printer page <path>
printer api <path>
crud <model>
```
48 changes: 48 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Printer is licensed under the terms of the GNU AGPLv3 with additional terms and
linking exceptions. The AGPLv3 license text can be found in the AGPLv3.txt file, the
additional terms are given below this paragraph.

Linking exceptions
------------------

In addition to the terms in the AGPLv3 the following linking exceptions apply:

The authors of this work grant the rights to dynamically link against the below
listed external sources or binaries during runtime, as an exception to the terms of
the GNU AGPLv3, under the terms that none of that linked code shall be deemed part of
this work, or a derivative work of this work, and as such are not required to meet
the license terms of the AGPLv3 and as such are not covered by the terms of the AGPLv3
when conveying this work.

The full and exhaustive list of those sources excepted from the AGPLv3 are:

* The Google Maps API v3 located at: http://maps.google.com/maps/api/js
* The twitter "follow button" widget located at http://platform.twitter.com/widgets.js
* The GitHub Gist API located at http://gist.github.com/{id}.js. This applies only to
the javascript coded issues by GitHub Inc. and explicitly does not apply to the
content of any GitHub gist.
* The disqus API located at http://<name>.disqus.com/embed.js where <name> is the
userid of the forum.


Additional terms to AGPLv3
-------------------------

In compliance with section 7 of the GNU AGPLv3 the following additional terms apply:

a) The contained and displayed copyright attribution footer notice may not be removed,
modified, altered or styled, or being removed, modified, altered or styled by
external software (scripts, stylesheets, filters) in a way that would considerably
affect visibility or readability of the notice to the user or any third party that
uses the software locally or over the network; this especially includes resizing,
overlaying, hiding or similar techniques.

b) You may adjust or style the copyright footer to suit the appearance or layout of
your website, as long as this does not violate the terms given in section (a)

c) Attribution hyperlinks in the footer have to be kept unaltered.

d) You may add your name to the list of copyright holder(s) in the footer if you make
changes to the work, keeping intact all other copyright holder names

e) Changes to these terms require written permission by the copyright holder(s).
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# 🖨️ Printer

![Printer Banner](./banner.jpg "Printer Banner")

## Automation Tooling for Next, Redux and Prisma

![license](https://img.shields.io/badge/license-AGPLv3-blue.svg)
![version](https://img.shields.io/badge/version-1.0.0-blue.svg)
[![CircleCI](https://circleci.com/gh/PrinterFramework/CLI.svg?style=svg)](https://circleci.com/gh/PrinterFramework/CLI)
[![codecov](https://codecov.io/gh/PrinterFramework/CLI/branch/master/graph/badge.svg)](https://codecov.io/gh/PrinterFramework/CLI)

## Why Printer?

- Easy to use Code Generation Tool.

- Boilerplate Automation

- Modularized

- Easy to scale

- Easy to manage type systems and interfaces

## How it works

1. Install printer:

```bash
# npm
npm install -g @printerframework/cli
# yarn
yarn global add @printerframework/cli
```

2. Create a new project:

```bash
printer new printer-sample
cd printer-sample
```

3. Start developing:

```bash
# Create a new component
printer component components/component
```

Review the documentation on [prntr.click/docs](https://prntr.click/docs).

Review the [CHANGELOG](./CHANGELOG.md) for any updates made to the project.

## Comments and Feedback

Very open to comments and feedback. Very welcoming to people who open issues with reasonable constructive feedback. Please do not open PRs unless you're willing to commit code that matches the conventions and styles of the repository.

## Licensing

[AGPLv3](./LICENSE) - This applies to hard forking printer. Not to Next.js projects generated with Printer.
13 changes: 13 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module.exports = {
presets: [
[
'@babel/preset-env',
{
targets: {
node: 'current'
}
}
],
'@babel/preset-typescript'
]
}
Binary file added banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions dist/src/config.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
export interface PrinterConfig {
componentFolder?: boolean;
component?: {
index?: boolean;
component?: boolean;
style?: boolean;
test?: boolean;
};
crud?: {
create: boolean;
update: boolean;
delete: boolean;
list: boolean;
get: boolean;
};
}
export declare let Config: PrinterConfig;
export declare function registerConfig(): void;
45 changes: 45 additions & 0 deletions dist/src/config.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions dist/src/config.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions dist/src/converter.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export declare function Converter(): Promise<void>;
export declare function RecurseConverter(path: string): Promise<void>;
export declare function ConvertTemplate(path: string, filename: string): Promise<void>;
Loading

0 comments on commit 24ddf9b

Please sign in to comment.