0.5.217 • Published 3 years ago

metalsmith-renamer v0.5.217

Weekly downloads
394
License
MIT
Repository
github
Last release
3 years ago

metalsmith-renamer

Test Release

This is a plugin for Metalsmith which renames files matching a given pattern.

❄️ Project Status

This project is on somewhat of an auto-pilot which means:

  • As I don't use Metalsmith any more, I'm not familiar enough with it to provide support with issues.
  • I will accept fixes and feature PRs only if:

Thanks for your understanding!


Usage

If using the CLI for Metalsmith, metalsmith-renamer can be used like any other plugin by including it in metalsmith.json. For example:

For Metalscript's JavaScript API, metalsmith-renamer can be used like any other plugin, by attaching it to the function invocation chain on the Metalscript object. For example:

import Metalsmith from "metalsmith";
import renamer from "metalsmith-renamer";

Metalsmith(__dirname)
  .use(
    renamer({
      "Markdown Files": { // this name is only used to help organize different settings
        pattern: "folder/**/*.md",
        rename: function (name) {
          return "renamed" + name;
        },
      },
      "HTML Pages": {
        pattern: "folder/about.html",
        rename: "index.html",
      }, // and as many more patterns as you want
    })
  )
  .build();

Options

metalsmith-renamer has two options, both of which must be defined:

  • pattern: option which uses minimatch to find files to rename.
  • rename: which takes a string argument for what you'd like the files to be named, or a function that takes a matched file name and returns the new one to be used.

Use cases

  • I use it to simulate metalsmith-permalinks partially by renaming certain files index.html, allowing me to link straight to directories and not have to use the filename. metalsmith-permalink insists on enclosing files within a structured folder system, whereas I have folder already organized manually.
0.5.213

3 years ago

0.5.212

3 years ago

0.5.215

3 years ago

0.5.214

3 years ago

0.5.211

3 years ago

0.5.210

3 years ago

0.5.209

3 years ago

0.5.208

3 years ago

0.5.207

3 years ago

0.5.217

3 years ago

0.5.216

3 years ago

0.5.206

3 years ago

0.5.205

3 years ago

0.5.202

3 years ago

0.5.201

3 years ago

0.5.204

3 years ago

0.5.203

3 years ago

0.5.200

3 years ago

0.5.187

3 years ago

0.5.186

3 years ago

0.5.189

3 years ago

0.5.188

3 years ago

0.5.194

3 years ago

0.5.193

3 years ago

0.5.196

3 years ago

0.5.195

3 years ago

0.5.190

3 years ago

0.5.192

3 years ago

0.5.191

3 years ago

0.5.198

3 years ago

0.5.197

3 years ago

0.5.199

3 years ago

0.5.185

3 years ago

0.5.184

3 years ago

0.5.179

3 years ago

0.5.178

3 years ago

0.5.177

3 years ago

0.5.183

3 years ago

0.5.182

3 years ago

0.5.181

3 years ago

0.5.180

3 years ago

0.5.174

3 years ago

0.5.176

3 years ago

0.5.175

3 years ago

0.5.172

3 years ago

0.5.171

3 years ago

0.5.173

3 years ago

0.5.170

3 years ago

0.5.150

4 years ago

0.5.152

4 years ago

0.5.151

4 years ago

0.5.158

4 years ago

0.5.157

4 years ago

0.5.159

4 years ago

0.5.154

4 years ago

0.5.153

4 years ago

0.5.156

4 years ago

0.5.155

4 years ago

0.5.161

3 years ago

0.5.160

3 years ago

0.5.163

3 years ago

0.5.162

3 years ago

0.5.169

3 years ago

0.5.168

3 years ago

0.5.165

3 years ago

0.5.164

3 years ago

0.5.167

3 years ago

0.5.166

3 years ago

0.5.149

4 years ago

0.5.147

4 years ago

0.5.146

4 years ago

0.5.148

4 years ago

0.5.145

4 years ago

0.5.143

4 years ago

0.5.144

4 years ago

0.5.141

4 years ago

0.5.140

4 years ago

0.5.142

4 years ago

0.5.138

4 years ago

0.5.137

4 years ago

0.5.139

4 years ago

0.5.136

4 years ago

0.5.135

4 years ago

0.5.134

4 years ago

0.5.133

4 years ago

0.5.132

4 years ago

0.5.131

4 years ago

0.5.130

4 years ago

0.5.129

4 years ago

0.5.128

4 years ago

0.5.127

4 years ago

0.5.125

4 years ago

0.5.126

4 years ago

0.5.124

4 years ago

0.5.123

4 years ago

0.5.121

4 years ago

0.5.122

4 years ago

0.5.120

4 years ago

0.5.119

4 years ago

0.5.118

4 years ago

0.5.117

4 years ago

0.5.116

4 years ago

0.5.115

4 years ago

0.5.114

4 years ago

0.5.113

4 years ago

0.5.112

4 years ago

0.5.111

4 years ago

0.5.110

4 years ago

0.5.109

4 years ago

0.5.103

4 years ago

0.5.102

4 years ago

0.5.105

4 years ago

0.5.104

4 years ago

0.5.101

4 years ago

0.5.100

4 years ago

0.5.107

4 years ago

0.5.106

4 years ago

0.5.108

4 years ago

0.5.99

4 years ago

0.5.98

4 years ago

0.5.96

4 years ago

0.5.97

4 years ago

0.5.94

4 years ago

0.5.95

4 years ago

0.5.92

4 years ago

0.5.93

4 years ago

0.5.91

4 years ago

0.5.90

4 years ago

0.5.89

4 years ago

0.5.88

4 years ago

0.5.87

4 years ago

0.5.86

4 years ago

0.5.85

4 years ago

0.5.84

4 years ago

0.5.83

4 years ago

0.5.82

4 years ago

0.5.81

4 years ago

0.5.80

4 years ago

0.5.79

4 years ago

0.5.78

4 years ago

0.5.76

4 years ago

0.5.77

4 years ago

0.5.75

4 years ago

0.5.74

4 years ago

0.5.73

4 years ago

0.5.72

4 years ago

0.5.71

4 years ago

0.5.70

4 years ago

0.5.69

4 years ago

0.5.67

4 years ago

0.5.68

4 years ago

0.5.66

4 years ago

0.5.65

4 years ago

0.5.64

4 years ago

0.5.63

5 years ago

0.5.62

5 years ago

0.5.61

5 years ago

0.5.60

5 years ago

0.5.59

5 years ago

0.5.58

5 years ago

0.5.57

5 years ago

0.5.56

5 years ago

0.5.55

5 years ago

0.5.54

5 years ago

0.5.53

5 years ago

0.5.52

5 years ago

0.5.51

5 years ago

0.5.50

5 years ago

0.5.49

5 years ago

0.5.48

5 years ago

0.5.47

5 years ago

0.5.46

5 years ago

0.5.45

5 years ago

0.5.44

5 years ago

0.5.43

5 years ago

0.5.42

5 years ago

0.5.41

5 years ago

0.5.40

5 years ago

0.5.39

5 years ago

0.5.38

5 years ago

0.5.37

5 years ago

0.5.36

5 years ago

0.5.35

5 years ago

0.5.34

5 years ago

0.5.33

5 years ago

0.5.32

5 years ago

0.5.31

5 years ago

0.5.30

5 years ago

0.5.29

5 years ago

0.5.28

5 years ago

0.5.27

5 years ago

0.5.26

5 years ago

0.5.25

5 years ago

0.5.24

5 years ago

0.5.23

5 years ago

0.5.22

5 years ago

0.5.21

5 years ago

0.5.20

5 years ago

0.5.19

5 years ago

0.5.18

5 years ago

0.5.17

5 years ago

0.5.16

5 years ago

0.5.15

5 years ago

0.5.14

5 years ago

0.5.13

5 years ago

0.5.12

5 years ago

0.5.10

5 years ago

0.5.11

5 years ago

0.5.9

5 years ago

0.5.8

5 years ago

0.5.7

5 years ago

0.5.6

5 years ago

0.5.5

5 years ago

0.5.4

5 years ago

0.5.3

5 years ago

0.5.2

5 years ago

0.5.1

5 years ago

0.5.1-next.1

5 years ago

0.5.0

5 years ago

0.5.0-next.1

5 years ago

0.4.0-next.1

5 years ago

0.4.1

6 years ago

0.4.0

8 years ago

0.3.0

9 years ago

0.2.2

10 years ago

0.2.1

10 years ago

0.2.0

10 years ago

0.1.0

10 years ago