Documentation
¶
Overview ¶
Copyright © 2019 Danil Pismenny <danil@brandymint.ru>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright © 2019 Danil Pismenny <danil@brandymint.ru>
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.
Copyright © 2019 Danil Pismenny <danil@brandymint.ru>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright © 2019 Danil Pismenny <danil@brandymint.ru>
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.
Index ¶
- Variables
- func CopyRemovingMagicComment(src, dst string) error
- func DirectoryExists(path string) bool
- func DownloadFile(filename string, url string, original_url string) error
- func Execute()
- func FetchUrlFromComment(comment string) string
- func GenerateMagicComment(url string, ext string) string
- func GetRepoFromUrl(url string) string
- func GetSubdirectoryFromUrl(url string) string
- func PushFileToRemoteRepository(file string, url string) error
- func ReadFirstLine(filename string) string
Constants ¶
This section is empty.
Variables ¶
var CommentPrefix = "goga"
var Formats = map[string]string{
".c": "// %s %s",
".cs": "// %s %s",
".js": "// %s %s",
".go": "// %s %s",
".java": "// %s %s",
".php": "// %s %s",
".slim": "// %s %s",
".sh": "# %s %s",
".haml": "// %s %s",
".rb": "# %s %s",
".py": "# %s %s",
".pl": "# %s %s",
".sql": "-- %s %s",
".swift": "-- %s %s",
".xml": "<!-- %s %s -->",
".html": "<!-- %s %s -->",
}
Functions ¶
func CopyRemovingMagicComment ¶ added in v0.1.0
Copy the src file to dst. Any existing file will be overwritten and will not copy file attributes.
func DirectoryExists ¶ added in v0.0.3
func DownloadFile ¶
DownloadFile will download a url to a local file. It's efficient because it will write as it downloads and not load the whole file into memory.
func Execute ¶
func Execute()
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func FetchUrlFromComment ¶ added in v0.1.0
func GenerateMagicComment ¶ added in v0.0.2
func GetRepoFromUrl ¶ added in v0.1.1
func GetSubdirectoryFromUrl ¶ added in v0.1.0
func PushFileToRemoteRepository ¶ added in v0.1.0
func ReadFirstLine ¶ added in v0.1.0
Types ¶
This section is empty.
Source Files