Documentation
¶
Overview ¶
Copyright © 2025 KubeRocketAI Team
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 © 2025 KubeRocketAI Team ¶
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 © 2025 KubeRocketAI Team ¶
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.
Index ¶
Constants ¶
const ( // FileStartDelimiter marks the beginning of a file section in a bundle FileStartDelimiter = "==== FILE: " // FileEndDelimiter marks the end of a file section in a bundle FileEndDelimiter = "==== END FILE ====" )
Bundle format delimiters
const ( // FilePermissions defines the default permission mode for created files FilePermissions = 0644 // DirPermissions defines the default permission mode for created directories DirPermissions = 0755 )
File system permissions
Variables ¶
This section is empty.
Functions ¶
func GenerateBundleFilename ¶
GenerateBundleFilename creates the bundle filename
Types ¶
type ExtractedFile ¶ added in v0.45.0
ExtractedFile represents a file extracted from a bundle
func ParseBundle ¶ added in v0.45.0
func ParseBundle(reader io.Reader) ([]ExtractedFile, error)
ParseBundle parses a bundle markdown file and extracts all files
type Extractor ¶ added in v0.45.0
type Extractor struct {
// contains filtered or unexported fields
}
Extractor handles extracting files from a bundle to the filesystem
func NewExtractor ¶ added in v0.45.0
NewExtractor creates a new bundle extractor
func (*Extractor) DryRun ¶ added in v0.45.0
func (e *Extractor) DryRun(files []ExtractedFile) []string
DryRun returns information about what would be extracted without actually writing files
func (*Extractor) Extract ¶ added in v0.45.0
func (e *Extractor) Extract(files []ExtractedFile) (*ExtractorStats, error)
Extract writes the extracted files to the filesystem
type ExtractorStats ¶ added in v0.45.0
ExtractorStats holds statistics about the extraction process