├── assets ├── icon.png ├── icon.blue.png ├── icon.red.png ├── icon.green.png ├── icon128.blue.png ├── icon128.red.png ├── icon16.blue.png ├── icon16.green.png ├── icon16.red.png ├── icon32.blue.png ├── icon32.green.png ├── icon32.red.png ├── icon48.blue.png ├── icon48.green.png ├── icon48.red.png ├── icon64.blue.png ├── icon64.green.png ├── icon64.red.png └── icon128.green.png ├── tsconfig.json ├── .gitignore ├── .prettierrc.mjs ├── .github └── workflows │ └── submit.yml ├── popup.css ├── package.json ├── README.md ├── background.ts ├── options.css ├── popup.tsx ├── options.tsx └── LICENSE /assets/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon.png -------------------------------------------------------------------------------- /assets/icon.blue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon.blue.png -------------------------------------------------------------------------------- /assets/icon.red.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon.red.png -------------------------------------------------------------------------------- /assets/icon.green.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon.green.png -------------------------------------------------------------------------------- /assets/icon128.blue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon128.blue.png -------------------------------------------------------------------------------- /assets/icon128.red.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon128.red.png -------------------------------------------------------------------------------- /assets/icon16.blue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon16.blue.png -------------------------------------------------------------------------------- /assets/icon16.green.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon16.green.png -------------------------------------------------------------------------------- /assets/icon16.red.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon16.red.png -------------------------------------------------------------------------------- /assets/icon32.blue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon32.blue.png -------------------------------------------------------------------------------- /assets/icon32.green.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon32.green.png -------------------------------------------------------------------------------- /assets/icon32.red.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon32.red.png -------------------------------------------------------------------------------- /assets/icon48.blue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon48.blue.png -------------------------------------------------------------------------------- /assets/icon48.green.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon48.green.png -------------------------------------------------------------------------------- /assets/icon48.red.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon48.red.png -------------------------------------------------------------------------------- /assets/icon64.blue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon64.blue.png -------------------------------------------------------------------------------- /assets/icon64.green.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon64.green.png -------------------------------------------------------------------------------- /assets/icon64.red.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon64.red.png -------------------------------------------------------------------------------- /assets/icon128.green.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ProLoser/Chrome-Dev-Hopper/main/assets/icon128.green.png -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "plasmo/templates/tsconfig.base", 3 | "exclude": [ 4 | "node_modules" 5 | ], 6 | "include": [ 7 | ".plasmo/index.d.ts", 8 | "./**/*.ts", 9 | "./**/*.tsx" 10 | ], 11 | "compilerOptions": { 12 | "paths": { 13 | "~*": [ 14 | "./*" 15 | ] 16 | }, 17 | "baseUrl": "." 18 | } 19 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 3 | 4 | # dependencies 5 | /node_modules 6 | /.pnp 7 | .pnp.js 8 | 9 | # testing 10 | /coverage 11 | 12 | # misc 13 | .DS_Store 14 | *.pem 15 | 16 | # debug 17 | npm-debug.log* 18 | yarn-debug.log* 19 | yarn-error.log* 20 | .pnpm-debug.log* 21 | 22 | # local env files 23 | .env*.local 24 | keys.json 25 | 26 | out/ 27 | build/ 28 | dist/ 29 | 30 | # plasmo 31 | .plasmo 32 | 33 | # typescript 34 | .tsbuildinfo 35 | -------------------------------------------------------------------------------- /.prettierrc.mjs: -------------------------------------------------------------------------------- 1 | /** 2 | * @type {import('prettier').Options} 3 | */ 4 | export default { 5 | printWidth: 80, 6 | tabWidth: 2, 7 | useTabs: false, 8 | semi: false, 9 | singleQuote: false, 10 | trailingComma: "none", 11 | bracketSpacing: true, 12 | bracketSameLine: true, 13 | plugins: ["@ianvs/prettier-plugin-sort-imports"], 14 | importOrder: [ 15 | "", // Node.js built-in modules 16 | "", // Imports not matched by other special words or groups. 17 | "", // Empty line 18 | "^@plasmo/(.*)$", 19 | "", 20 | "^@plasmohq/(.*)$", 21 | "", 22 | "^~(.*)$", 23 | "", 24 | "^[./]" 25 | ] 26 | } 27 | -------------------------------------------------------------------------------- /.github/workflows/submit.yml: -------------------------------------------------------------------------------- 1 | name: "Submit to Web Store" 2 | on: 3 | workflow_dispatch: 4 | push: 5 | tags: 6 | - "v*.*.*" 7 | 8 | jobs: 9 | build: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v3 13 | - name: Use Node.js 20.x 14 | uses: actions/setup-node@v3.4.1 15 | with: 16 | node-version: 20.x 17 | cache: "yarn" 18 | - name: Install dependencies 19 | run: yarn install --frozen-lockfile 20 | - name: Build the extension 21 | run: yarn build 22 | - name: Package the extension into a zip artifact 23 | run: yarn package 24 | - name: Browser Platform Publish 25 | uses: PlasmoHQ/bpp@v3 26 | with: 27 | keys: ${{ secrets.SUBMIT_KEYS }} 28 | artifact: build/chrome-mv3-prod.zip -------------------------------------------------------------------------------- /popup.css: -------------------------------------------------------------------------------- 1 | body { 2 | font-size: 14px; 3 | margin: 0; 4 | font-family: sans-serif; 5 | } 6 | 7 | .popup-container { 8 | width: 250px; 9 | } 10 | 11 | h3 { 12 | white-space: nowrap; 13 | text-align: center; 14 | padding: 10px 0 0; 15 | margin: 0 0 10px; 16 | display: flex; 17 | justify-content: space-between; 18 | align-items: center; 19 | padding: 10px; 20 | } 21 | h3 a { 22 | cursor: pointer; 23 | color: #999; 24 | transition: all ease 0.2s; 25 | padding: 5px; 26 | margin: -5px; 27 | text-decoration: none; 28 | } 29 | h3 a:hover { 30 | color: #00BCD4; 31 | } 32 | 33 | ul { 34 | list-style: none; 35 | margin: 0; 36 | padding: 0; 37 | } 38 | ul a { 39 | text-decoration: none; 40 | padding: 5px; 41 | display: block; 42 | color: #000; 43 | } 44 | ul a:hover { 45 | background: #B2EBF2; 46 | } 47 | ul a.active { 48 | color: white !important; 49 | background: #00BCD4; 50 | } 51 | 52 | small { 53 | color: #aaa; 54 | } 55 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "chrome-dev-hopper", 3 | "displayName": "Chrome Dev Hopper", 4 | "version": "0.1.2", 5 | "description": "Quickly jump between development, staging and production servers. For develhoppers", 6 | "homepage": "https://github.com/ProLoser/Chrome-Dev-Hopper", 7 | "author": "Dean Sofer", 8 | "scripts": { 9 | "dev": "plasmo dev", 10 | "build": "plasmo build", 11 | "package": "plasmo package" 12 | }, 13 | "dependencies": { 14 | "@plasmohq/storage": "^1.15.0", 15 | "plasmo": "0.90.5", 16 | "react": "18.2.0", 17 | "react-dom": "18.2.0" 18 | }, 19 | "devDependencies": { 20 | "@ianvs/prettier-plugin-sort-imports": "4.1.1", 21 | "@types/chrome": "0.0.258", 22 | "@types/node": "20.11.5", 23 | "@types/react": "18.2.48", 24 | "@types/react-dom": "18.2.18", 25 | "prettier": "3.2.4", 26 | "typescript": "5.3.3" 27 | }, 28 | "manifest": { 29 | "permissions": [ 30 | "activeTab", 31 | "tabs" 32 | ] 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Chrome Dev Hopper 2 | 3 | This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo). 4 | 5 | ## Getting Started 6 | 7 | First, run the development server: 8 | 9 | ```bash 10 | yarn dev 11 | ``` 12 | 13 | Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`. 14 | 15 | You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser. 16 | 17 | For further guidance, [visit our Documentation](https://docs.plasmo.com/) 18 | 19 | ## Making production build 20 | 21 | Run the following: 22 | 23 | ```bash 24 | yarn build 25 | ``` 26 | 27 | This should create a production bundle for your extension, ready to be zipped and published to the stores. 28 | 29 | ## Submit to the webstores 30 | 31 | The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/framework/workflows/submit) and you should be on your way for automated submission! 32 | -------------------------------------------------------------------------------- /background.ts: -------------------------------------------------------------------------------- 1 | import { Storage } from "@plasmohq/storage" 2 | import icon16blue from 'url:~assets/icon16.blue.png' 3 | import icon32blue from 'url:~assets/icon32.blue.png' 4 | import icon64blue from 'url:~assets/icon64.blue.png' 5 | import icon128blue from 'url:~assets/icon128.blue.png' 6 | import icon16green from 'url:~assets/icon16.green.png' 7 | import icon32green from 'url:~assets/icon32.green.png' 8 | import icon64green from 'url:~assets/icon64.green.png' 9 | import icon128green from 'url:~assets/icon128.green.png' 10 | const popup = chrome.runtime.getURL("popup.html") 11 | 12 | export {} 13 | 14 | const shouldShowMap = new Map() 15 | const storage = new Storage() 16 | 17 | const onUpdate = async (tabId, tab) => { 18 | if (tab.url) { 19 | const projects = (await storage.get("projects")) || [] 20 | const shouldShow = projects?.find?.((project) => 21 | project.environments?.some((environment) => 22 | new RegExp(environment.regex).test(tab.url) 23 | ) 24 | ) 25 | 26 | shouldShowMap.set(tabId, !!shouldShow) 27 | 28 | if (!!shouldShow) { 29 | // chrome.action.setBadgeBackgroundColor({ color: "#4CAF50" }) 30 | // chrome.action.setTitle({ title: "Dev Hopper Active" }) 31 | // chrome.action.setBadgeTextColor({ color: "#FF0000" }) 32 | chrome.action.setBadgeText({ tabId, text: `${shouldShow.environments.length}` }) 33 | chrome.action.setPopup({ tabId, popup }) 34 | chrome.action.setIcon({ tabId, path: { 35 | "16": icon16green, 36 | "32": icon32green, 37 | "48": icon64green, 38 | "128": icon128green 39 | } }) 40 | 41 | } else { 42 | chrome.action.setPopup({ tabId, popup: '' }) 43 | chrome.action.setBadgeText({ tabId, text: '' }) 44 | chrome.action.setIcon({ tabId, path: { 45 | "16": icon16blue, 46 | "32": icon32blue, 47 | "48": icon64blue, 48 | "128": icon128blue 49 | } }) 50 | } 51 | } 52 | } 53 | 54 | chrome.tabs.onActivated.addListener(async (activeInfo) => { 55 | const tab = await chrome.tabs.get(activeInfo.tabId) 56 | await onUpdate(tab.id, tab) 57 | }) 58 | chrome.tabs.onUpdated.addListener(async (tabId, changeInfo, tab) => { 59 | if (changeInfo.status === "complete") { 60 | await onUpdate(tabId, tab) 61 | } 62 | }) 63 | 64 | chrome.action.onClicked.addListener((tab) => { 65 | if (!shouldShowMap.get(tab.id)) { 66 | chrome.runtime.openOptionsPage() 67 | } 68 | }) -------------------------------------------------------------------------------- /options.css: -------------------------------------------------------------------------------- 1 | * { 2 | box-sizing: border-box; 3 | } 4 | 5 | body { 6 | font-size: 14px; 7 | margin-top: 60px; 8 | font-family: sans-serif; 9 | } 10 | 11 | a { 12 | cursor: pointer; 13 | } 14 | 15 | ul { 16 | list-style: none; 17 | padding: 0; 18 | margin: 0; 19 | } 20 | 21 | .options-container { 22 | max-width: 800px; 23 | margin: 0 auto; 24 | padding: 20px; 25 | } 26 | 27 | .environments { 28 | li { 29 | margin: 10px 0; 30 | padding: 10px; 31 | border: 1px solid #eee; 32 | border-radius: 4px; 33 | } 34 | } 35 | 36 | button { 37 | cursor: pointer; 38 | 39 | span { 40 | &.r { 41 | border-left: 1px solid #888; 42 | box-shadow: -1px 0 1px rgba(255,255,255,.4), inset 1px 0 1px rgba(255,255,255,.4); 43 | padding-top: 5px; 44 | padding-bottom: 5px; 45 | padding-left: 9px; 46 | margin-left: 8px; 47 | font-weight: bold; 48 | } 49 | &.l { 50 | border-right: 1px solid #888; 51 | box-shadow: 1px 0 1px rgba(255,255,255,.4), inset -1px 0 1px rgba(255,255,255,.4); 52 | padding-top: 5px; 53 | padding-bottom: 5px; 54 | padding-right: 9px; 55 | margin-right: 8px; 56 | font-weight: bold; 57 | } 58 | } 59 | } 60 | 61 | header { 62 | position: fixed; 63 | padding: 10px 20px; 64 | top: 0; 65 | left: 0; 66 | right: 0; 67 | box-shadow: 0 2px 5px rgba(0,0,0,.2); 68 | background: white; 69 | z-index: 10; 70 | } 71 | 72 | .alert { 73 | position: absolute; 74 | top: 0; 75 | left: 0; 76 | bottom: 0; 77 | right: 0; 78 | padding: 10px 20px; 79 | text-align: center; 80 | line-height: 40px; 81 | background: #8BC34A; 82 | color: white; 83 | margin: 0; 84 | height: 100%; 85 | } 86 | 87 | .right { 88 | float: right; 89 | } 90 | .left { 91 | float: left; 92 | } 93 | .center { 94 | text-align: center; 95 | } 96 | 97 | .row { 98 | overflow: hidden; 99 | } 100 | 101 | .projects { 102 | label { 103 | display: block; 104 | overflow: hidden; 105 | text-align: right; 106 | line-height: 2em; 107 | margin-bottom: 5px; 108 | } 109 | 110 | button { 111 | min-height: 0; 112 | min-width: 0; 113 | padding: 8px 12px; 114 | border-radius: 4px; 115 | border: 1px solid #ccc; 116 | background-color: #f0f0f0; 117 | } 118 | 119 | input { 120 | display: block; 121 | float: right; 122 | text-align: left; 123 | width: 70%; 124 | margin-left: 10px !important; 125 | border: none; 126 | padding: 5px; 127 | border-bottom: 1px solid #ccc; 128 | } 129 | 130 | > li { 131 | margin-bottom: 20px; 132 | padding: 20px; 133 | border: 1px solid #ddd; 134 | border-radius: 4px; 135 | } 136 | > li:last-child { 137 | border-bottom: 1px solid #ddd; 138 | } 139 | } 140 | 141 | .trash { 142 | padding: 5px; 143 | margin-left: -5px; 144 | margin-right: 5px; 145 | 146 | img { 147 | width: 16px; 148 | height: 16px; 149 | vertical-align: middle; 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /popup.tsx: -------------------------------------------------------------------------------- 1 | import { useStorage } from "@plasmohq/storage/hook" 2 | import { useEffect, useState } from "react" 3 | import "./popup.css" 4 | 5 | function IndexPopup() { 6 | const [projects, setProjects] = useStorage("projects", []) 7 | const [project, setProject] = useState(null) 8 | const [error, setError] = useState(null) 9 | 10 | useEffect(() => { 11 | chrome.tabs.query({ active: true, currentWindow: true }, (tabs) => { 12 | if (chrome.runtime.lastError) { 13 | setError("Error getting active tab: " + chrome.runtime.lastError.message) 14 | return 15 | } 16 | const activeTab = tabs[0] 17 | if (!activeTab) { 18 | setError("Could not find active tab.") 19 | return 20 | } 21 | 22 | const foundProject = projects.find((p) => 23 | p.environments.some((e) => new RegExp(e.regex).test(activeTab.url)) 24 | ) 25 | 26 | if (foundProject) { 27 | const updatedEnvironments = foundProject.environments.map((env) => { 28 | const match = activeTab.url.match(new RegExp(env.regex)) 29 | if (match) { 30 | return { ...env, active: true } 31 | } else { 32 | const activeEnv = foundProject.environments.find(e => new RegExp(e.regex).test(activeTab.url)); 33 | const activeMatch = activeTab.url.match(new RegExp(activeEnv.regex)); 34 | return { 35 | ...env, 36 | url: activeTab.url.replace(activeMatch[0], env.base), 37 | active: false, 38 | } 39 | } 40 | }) 41 | setProject({ ...foundProject, environments: updatedEnvironments }) 42 | } 43 | }) 44 | }, [projects]) 45 | 46 | const openOptionsPage = () => { 47 | chrome.runtime.openOptionsPage() 48 | } 49 | 50 | const goToUrl = (url) => { 51 | chrome.tabs.query({ active: true, currentWindow: true }, (tabs) => { 52 | if (chrome.runtime.lastError) { 53 | setError("Error getting active tab: " + chrome.runtime.lastError.message); 54 | return; 55 | } 56 | const activeTab = tabs[0]; 57 | if (activeTab) { 58 | chrome.tabs.update(activeTab.id, { url }); 59 | window.close(); 60 | } 61 | }); 62 | } 63 | 64 | if (error) { 65 | return
Error: {error}
66 | } 67 | 68 | return ( 69 |
70 | {project ? ( 71 | <> 72 |

73 | {project.name} 74 | ✎ 75 |

76 | 94 | 95 | ) : ( 96 |
97 |

98 | No matching project found for this URL. 99 |

100 |

101 | 104 |

105 |
106 | )} 107 |
108 | ) 109 | } 110 | 111 | export default IndexPopup 112 | -------------------------------------------------------------------------------- /options.tsx: -------------------------------------------------------------------------------- 1 | import { useStorage } from "@plasmohq/storage/hook" 2 | import { useCallback, useState } from "react" 3 | import "./options.css" 4 | 5 | const PLACEHOLDERS = [ 6 | { 7 | name: 'Production', 8 | regex: 'example\\.com', 9 | replace: 'example.com', 10 | }, 11 | { 12 | name: 'Staging', 13 | regex: 'test\\.com', 14 | replace: 'test.com', 15 | }, 16 | { 17 | name: 'Localhost', 18 | regex: 'localhost:3000', 19 | replace: 'localhost:3000', 20 | } 21 | ] 22 | 23 | const newProject = () => ({ name: "", environments: [{ name: "", regex: "", base: "" }, { name: "", regex: "", base: "" }] }) 24 | const DEFAULT_PROJECTS = [newProject()] 25 | 26 | export default function OptionsIndex() { 27 | const [projects, setStore, { 28 | setRenderValue 29 | }] = useStorage("projects", DEFAULT_PROJECTS) 30 | const [saved, setSaved] = useState(false) 31 | 32 | const handleProjectChange = (index, field, value) => { 33 | const newProjects = [...projects] 34 | newProjects[index][field] = value 35 | // setProjects(newProjects) 36 | setRenderValue(newProjects) 37 | } 38 | 39 | const handleEnvChange = (projIndex, envIndex, field, value) => { 40 | const newProjects = [...projects] 41 | newProjects[projIndex].environments[envIndex][field] = value 42 | // setProjects(projects) 43 | setRenderValue(newProjects) 44 | } 45 | 46 | const addProject = () => { 47 | // setProjects([...projects, newProject()]) 48 | setRenderValue([...projects, newProject()]) 49 | } 50 | 51 | const removeProject = (index) => { 52 | const newProjects = projects.filter((_, i) => i !== index) 53 | // setProjects(newProjects) 54 | setRenderValue(newProjects) 55 | } 56 | 57 | const addEnvironment = (projIndex) => { 58 | const newProjects = [...projects] 59 | newProjects[projIndex].environments.push({ name: "", regex: "", base: "" }) 60 | // setProjects(projects) 61 | setRenderValue(newProjects) 62 | } 63 | 64 | const removeEnvironment = (projIndex, envIndex) => { 65 | const newProjects = [...projects] 66 | newProjects[projIndex].environments = newProjects[projIndex].environments.filter( 67 | (_, i) => i !== envIndex 68 | ) 69 | // setProjects(projects) 70 | setRenderValue(newProjects) 71 | } 72 | 73 | const submitHandler = useCallback((e) => { 74 | e.preventDefault() 75 | 76 | // setProjects(projects) 77 | setStore(projects) 78 | setSaved(true) 79 | setTimeout(() => setSaved(false), 2000) 80 | }, [projects]) 81 | 82 | return ( 83 |
84 |
85 | 88 | 91 | {saved &&

Changes Saved

} 92 |
93 | 94 |
    95 | {projects.length === 0 && ( 96 |
  • 97 |

    No projects found. Add a project to get started.

    98 | 99 | 102 |
    • 103 | )} 104 | {projects.map((project, projIndex) => ( 105 |
  • 106 | 118 |
      119 | {project.environments.map((env, envIndex) => ( 120 |
    • 121 | 138 | 149 | 160 |
      • 161 | ))} 162 |
    163 |

    164 | 167 |

    168 |
    • 169 | ))} 170 |
171 |
172 | ) 173 | } 174 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------